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.511.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 97d3293002e9b5f0f4ac340f999c26d69bec7d11580afa1f03befce2315ab664 |
|
MD5 | c19daccb10e11ac3f9e941747422505b |
|
BLAKE2b-256 | a56f9a2c9a1adc94ee62e05f74c9995bc22b1d44c3f58aa63bbc5f8008d7053a |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.511-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6c9a71e08baeac6d3dc2f229ef148a6dbbb16711084b87a37bd5e8ce93d0b03a |
|
MD5 | dadac716bb7ffded4138a6aefaecdc84 |
|
BLAKE2b-256 | 16de832cc4b3185fe4b4b142852d5ba40dceb51396bb36d879537255bd26e5b4 |