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.619.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 52d68ff85959bcf96063aaecc799a8d83f5d0bef67399fcbf0a06c2bcc417bfb |
|
MD5 | 2cd5ce46e5a82e36daf99961fa995275 |
|
BLAKE2b-256 | eae588c2a769f9f8d4f6578307cf7fb4325dbd8ee8979897865c31a4b91758be |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.619-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 51dea0d9163d6925ae8be26f596d56535dc580e95c5fed7d55981db867f133b3 |
|
MD5 | 0cf08b8fa6c82971012f995fe977321d |
|
BLAKE2b-256 | d88570064f43cc65b06a8b4bdf2f9921e34fc7f1a032a11ef52a485663d63b4d |