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.752.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ec5456b7d6065fcf1820b152c2cedffc50161fa165864cb21f715b2d46afabed |
|
MD5 | 4007c84d89a96f67201a238f3de8cca6 |
|
BLAKE2b-256 | 21926cccd7bef6aba181c1f9b636b5c6935aba2a68e1420bd7387c0d210347a0 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.752-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 75881637d5b1694b2970c92009ba1957c7d1d3491ccaef14def6006b93da7a12 |
|
MD5 | 6af8ed57583deb230baf3e19e7ab21d5 |
|
BLAKE2b-256 | a59de7ebeccce8ecfb1cee34a8963729e42cb8b9b4724d4daad1edbda1686128 |