Add SwaggerUI to your AWS Apigateway RestApi
Project description
CDK Apigateway SwaggerUI
Add SwaggerUI to your AWS Apigateway RestApi
Install
TypeScript
npm install @pepperize/cdk-apigateway-swagger-ui
or
yarn add @pepperize/cdk-apigateway-swagger-ui
Python
pip install pepperize.cdk-apigateway-swagger-ui
C# / .Net
dotnet add package Pepperize.CDK.ApigatewaySwaggerUi
Java
<dependency>
<groupId>com.pepperize</groupId>
<artifactId>cdk-apigateway-swagger-ui</artifactId>
<version>${cdkApigatewaySwaggerUi.version}</version>
</dependency>
Usage
import { Stack } from "aws-cdk-lib";
import * as apigateway from "aws-cdk-lib/aws-apigateway";
import { SwaggerUi } from "@pepperize/cdk-apigateway-swagger-ui";
const stack = new Stack();
const restApi = new apigateway.RestApi();
new SwaggerUi(stack, "SwaggerUI", { resource: restApi.root });
- Open your SwaggerUI:
https://<rest api id>.execute-api.<aws region>.amazonaws.com/<stage>/api-docs/swagger-ui.html
- View your API docs:
https://<rest api id>.execute-api.<aws region>.amazonaws.com/<stage>/api-docs.json
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for pepperize.cdk-apigateway-swagger-ui-0.0.415.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e7acc18e7d7f1fc0e39988fcda361ee23b2590e4ac9c0d5b83b6874f1fe8bf0d |
|
MD5 | 4a99de8411afeac12c29767bb3cd903a |
|
BLAKE2b-256 | 3ced4b1676193549370253335bc38cb6a5fdb59f356757a85dfd4abd4bbb33e9 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.415-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b0f589225eb1d0e9d8a7a4c6de57b3e94feb63425e4693767f391f01b970e11c |
|
MD5 | c92b2233473f804fd5e34c320f717617 |
|
BLAKE2b-256 | b8e72e3c346ea4c3a1543ae79bcfb1c6026eb2deb7dc0497e203518ae212b780 |