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.56.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | edffcdd7ec34ed12c8a87bc6e9fd715b5a0df8cdcb54d3484f51433617be3c07 |
|
MD5 | c41f990ac1051e999dfc4a67d183bac0 |
|
BLAKE2b-256 | 0fb35de07862f43ad0cbeffb1b9d2ff7e8cfe6466abb5d15776502235a1272ec |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.56-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c996c7f0f9d2ddd0a546f19f7923fec043e95e891e14c75b39205d0431968a55 |
|
MD5 | 6a88e532c95e44dca049342cf9e4d3d9 |
|
BLAKE2b-256 | b55af83965c41371d6d5b2e3d5ddbd525f244698579fc725c7ba140e4e6f30ff |