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.376.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e3a99e7b52153fbe010bf7edc6dae6c4d509479ae4aaa2589722157097cb6d2c |
|
MD5 | 3c7ada3be5e5990d94e2043c7bed399e |
|
BLAKE2b-256 | 7b5415ed4256bd672c63b2176716956167804eb9f1f067ba6328780e9caadf22 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.376-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8310f85f8ca4541a449aacca266d8f0ce5788aebc111bceb697e177200c5a0de |
|
MD5 | a8de103ae61a26a366992dcd56cf2b6f |
|
BLAKE2b-256 | d3b65d49cbd934fdbb339a30085de95324c5a4795e5e96499ee5a5b8e40e7e6d |