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.15.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c74b4c7e3353dab1442d884c95d220e9a7f70fc10de828bb503ddf06aad3a5e8 |
|
MD5 | 70a0519540a267c46d86bb58bcbb352b |
|
BLAKE2b-256 | 4fbb4727009340d56844dbf21552c014ce0562fbaa0cbef20ff36acebe30794b |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.15-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4ed3e38e93adbecfc5ad75763243d04d32985d019d77f25cc320c0b3dba51b49 |
|
MD5 | 3f3e320eb8f6360e6520ec38700a496e |
|
BLAKE2b-256 | 098b4f45e5ed7106e683c4273c3d71aeeba5871d6570529db97090a4fd7f5c08 |