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.115.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 32181dfb5617741af9f94243b7da66e02c8d98812f4601404ee3b8ae235b9e1f |
|
MD5 | 1244d064edd9a97e8e0d9be65a48166d |
|
BLAKE2b-256 | 8d2de312134dbfc3c28cc46f251a95066a9e190a3871cb81a179110279e46e6c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.115-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 34b92741b5923680463afc4efccb92713c5757a770231fd1ab689a6367e1f835 |
|
MD5 | 28e4cc88b5066e1ed0944804e489c9f4 |
|
BLAKE2b-256 | 5ae983a15e070eb08677ab3f9026537ebda7db934a5b35d145367342ada94acb |