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.35.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a6b1ace64bc3e8ab407f7f36659d4c68da37265fad93ad1df5cbb53b4b5d972f |
|
MD5 | 531ea6228b933604eac2ab01ff94aff5 |
|
BLAKE2b-256 | 9200210b92989f73c1071d34c2c819e5895834c08bc00d82fddd2eae84741012 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.35-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9ddf084707ef6f5d3c87397ff0fa8ac3ed1f76886e4bbe1b860fcf0d9e18f2d7 |
|
MD5 | 23093fcc9c35df8ebcecbb701eadf986 |
|
BLAKE2b-256 | 5e4d9e0701f7279124e24fad791fa3751f4441689f2490fe5f99c895043eb4d9 |