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.42.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 59b97be866fad99a4fc280b796005eacca2a0241319333bc041e93a98d263b92 |
|
MD5 | c79dd967d5c001e9209abfea887ed7e6 |
|
BLAKE2b-256 | 9cfff806699b05bd55c98dfeb34f677c55c4dd15ec866e37df398553f92a0f82 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.42-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0919afe594cc16ab956a5076cfcf0e1116ea0c62e1f90d9567a136cd16a40fb3 |
|
MD5 | 2ee1da82947e372477d67007f934e15d |
|
BLAKE2b-256 | c6e4267afde683d82b390f5e15e09c2f2ae958043f675a4a24b95c1f17628fa0 |