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.496.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2744188b37d0bc293a2716319bd094ac795afeab949f442760180a75ebcca6b2 |
|
MD5 | 597c325cb34908479977dc9fe4d3f1ef |
|
BLAKE2b-256 | 2116b3831c864df46b588cbcd7cab53cd08a7514a52cbed16af04c6e3032ec60 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.496-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 619090ef5a768f2806d422e6091571e37e6b1a1de65d8992da08400510e51567 |
|
MD5 | 046aa00fa581eea98f9a24b58e61965a |
|
BLAKE2b-256 | 537f4278a3133f43efce218774d6fce1033a60b8bc4acc581cff63b912ca14aa |