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.871.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a8b0de5c2c56754262d1ca2f2f9b64b70011fbfd9fa3997763bb525d58c8dfc4 |
|
MD5 | 9e41c3a2370f2e397c60b02bd43393a7 |
|
BLAKE2b-256 | b7078cc4fc567e31a0f37ad9eebc9a22b0ea9c4b851800e87603bc50ebf013c2 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.871-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5ff5909c8894455cb1816470476dc74e6ff2841dcceb89476dbc0ec35c02ec32 |
|
MD5 | 70bc9cf65e5fef6368ca37dee8e96499 |
|
BLAKE2b-256 | 4625b7a9f75e69c76e1dd7f3777544af9996dc57856f704d2419ac6fd70a2ba7 |