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.516.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4953c5324c04bf29a312874f5848ee2bfbd842e643495b005fec4441a5ef9cfd |
|
MD5 | e622a7f576be59012c05e7c0ffd8a962 |
|
BLAKE2b-256 | e599b145df38c111d7c0706a91af5e6af19e2205e0e98a43c493a66d02de9002 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.516-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b8ee78a6d4883e5e55675ca25185d74297f7a2950c49a8bff82967f0ba1fea38 |
|
MD5 | a455bcf9cb9aad6d5de17b64e9edd282 |
|
BLAKE2b-256 | f8e7cc11b267e2e1fa88f1e81aba8b51422513ec0124c71fd075121d8cc7ed3d |