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.228.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e2de7642d20e4e6b7c4decfd6c88c3949924855dee3d49863d2ac1420bb61670 |
|
MD5 | 135b442c5a31ed0de43d5a567d2f6553 |
|
BLAKE2b-256 | 1eb0e292894846bd75601c3db8906108d5519a4dae885030192d1072e932c3e5 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.228-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 905041a9831059bd9dbcce2dbee492dd31282e6e2008fc74786500098e1e6122 |
|
MD5 | f04b90a24f79eb2589146ed9efa82424 |
|
BLAKE2b-256 | 49d5b7a8c3445a972e1f2c20086ceb683cbab9a2750deb047c4b842598fbd232 |