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.202.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 75ec0566d13f55732af15fed9a6b58ad127e5d1ae8df9f16eb4d5136a2b947ed |
|
MD5 | d3f37521e68f32fd04b95a87b803b0cb |
|
BLAKE2b-256 | 68a1f6fe9a2d16e315a32a5f42fc6a631fa7bca44caa7235a245e8cb95d9be7a |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.202-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 90810c56b555b586460f168276eddf9dad6d9b022f68b92d7b06b4416a6b137a |
|
MD5 | c1d88fdb5d1c76f22d8522c245c506ff |
|
BLAKE2b-256 | ee0270135bf36e52988219bf1ad3be954a2750dc0489473ee3ac36131fc8eb2f |