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.815.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 127b3f4e3dfa0e4b19afc125fee115431b65b04f04322052fbf6bd98975bfb03 |
|
MD5 | d11b854cd536cb1a108ac9d06387a96e |
|
BLAKE2b-256 | 25dc53d7f4e00255bb42eb392e1cc6c78e3fb53ed33e0b0eb0f67f66bdbd8053 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.815-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | efb93b1765e58a8dd0d165f0a3a256a1f28ad10d92300b0ead6e482761704965 |
|
MD5 | 3c93a0a6eb19482ec1bb050574ecb9c5 |
|
BLAKE2b-256 | c80d52b903c1ab9026b335857fb6c531323191306b877918395f0974b6ac1c36 |