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.459.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 58eeaeff0bf95467a4751d46360e8f72dc1fd9367d955a127dffb98495b244c4 |
|
MD5 | a263cffe5e8a202b13d42df55d8f5bef |
|
BLAKE2b-256 | 721dba28f5290d63a8cd89499db2e4de135cf1472f315a0e224eb69dd37b18d7 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.459-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f2630980c37eb7a4d425dbd037814b2295f0f017d4c626ec8e279f90c5277c5a |
|
MD5 | 001900607febebff19ca6cac2d6c042e |
|
BLAKE2b-256 | ba0fc8d9e0c42ca76a48de4b41bc44de28c48b05a1a442c9fb173c6d495f5086 |