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.199.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 783612d4836771619f781156d593088cf3236be8fd553d8042d947b7b0bb0581 |
|
MD5 | 299f4e37a1e8175078650aac43d0bc6c |
|
BLAKE2b-256 | 0ba5803fec967d90482436f4b4d3900397e453fbdb057700292708c7d9feb996 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.199-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1cffd70891e044ce487525df3d0cc061faac689927b0833bd50e7ec322a325d0 |
|
MD5 | 8ff2cbb714504b7cff11a8ffaa076bbf |
|
BLAKE2b-256 | 3eeca3b2fa002d97efd85f2e4ffb7262e36e2297f0fd51bfeb651ac6b09ec49c |