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.900.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0101810ad6bf17905e285197364d819c340d015f6cdcb7a3e3d3cee130379d57 |
|
MD5 | 98eba35063538e74c3041aaac3e9aeaa |
|
BLAKE2b-256 | c52436ff373db0e1e38559ecebcd7d361ab742645b76d272dd5e1422698cbb15 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.900-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb3d429a9d96bad0cf05ebfc353c393e35a3b7931a753731fe5873b91415ced3 |
|
MD5 | 45f4cc121dc5e71b5f560c3877f7a8c2 |
|
BLAKE2b-256 | 12859dab9a49e114edee70625289d760abb23d81ce6a5718ba8bf0fbbfb039ce |