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.317.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc20f63407476e2d7736b4644b0324ce53c1ae73670d8b79e6cb00d764784c31 |
|
MD5 | bb35852b5152cc2989df64cee9e68983 |
|
BLAKE2b-256 | 750299c1186c07d9b853dd0960523c6bd3bbdb6ee77544163abc9046005d0ae1 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.317-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 19e65c9d74c1f39a7ef33551c2a9ab74ad8c50a1b5336885fcdd667aae9eb0b5 |
|
MD5 | f2c0744a4dddefcd3fd803dd6491f98c |
|
BLAKE2b-256 | 3748ad49fd569f1432eade96abd09878a17e521cc9595c046f68c7498476a5df |