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.631.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5192125da506797496954f55f9d087c2e39a28571218a0e23d1ef49053ce231a |
|
MD5 | a7e7fd5a6b098ea0b5508637b1eb2664 |
|
BLAKE2b-256 | fbf0d1c53bbeae7051a58daac8cd3ea90051b2efde9581c84fd67acf2b55c3e3 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.631-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9150793160faaa380dc6f6645fe6dedce3e9f4cc45e2c22551c41d459f5c12b0 |
|
MD5 | 37da4cce0e10d3526aae2f9e21945053 |
|
BLAKE2b-256 | 37386a005ac529e1802ca860d331e209e9d257545cfd66fd041b8ea06bec135c |