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.355.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 54e6b201c6651c484ea6d5ec3a37e40496a158b096a46963f7eadb1f1a202364 |
|
MD5 | 505ef214854cb2161b196a56db033bf7 |
|
BLAKE2b-256 | d34ee66f61a6cee3b0c95d5b646bac94aaf95a077ad2bebca2822353a28a90a7 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.355-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f1f48699b070ec0f21c386777add7de86c609db9c4de41cbd15a57a6f0bec074 |
|
MD5 | 74ea3a01d3ec553dd14ff58720fa8afb |
|
BLAKE2b-256 | d771ca175de3fdfbf8fe10374e9851f06847571a7964a6d6574121831d84dbad |