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.633.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e9b737f0cd0b691bab659e366206aeddda869e08eda9f272d81b48c30ad7ffae |
|
MD5 | 467de7434b1c1c2f5705ea576901c980 |
|
BLAKE2b-256 | a35bac31d6778de904c7062d72675d2f7662f0a19aba8cf89779e5c547093cb9 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.633-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c51e8ab4877e321f4960740f85bd9c3d871a45f9bbbff0380fd72803e166a1fe |
|
MD5 | 6c456185f3104bc9d1c85dd775b5af40 |
|
BLAKE2b-256 | e519114a915c69491be23b0d5771e416c8df087d96fa0b71d7ca1ec06c6b5189 |