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.224.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 231a2f9a49f8c4c9d20ea7515289d88af59bf31edd588b31b84099cfc66ef040 |
|
MD5 | 941c4758dfcd6cafb7f9d97d59be4da7 |
|
BLAKE2b-256 | d565e5c0cbcdb79be44088d80d6243aa62ed5427df04baa8a3e10e2691ac1d29 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.224-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 05ef6b96fb47fc19b39eb7c2ddd6752d9612bc494936ac88b42f734bd98a2220 |
|
MD5 | ef24b6866ab1ffedae93dfdbf7fa88f0 |
|
BLAKE2b-256 | 6fb1a441ad44014a6a70697aba6a540fe4ce7e4551a65b4e98a9ff887dccfc86 |