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.450.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3bc2a2009b9b3fd925afb4f3eba12051a8ea73d666f61456cf8d0c4760fad6be |
|
MD5 | 4741f3a05909609b9d812c518169deba |
|
BLAKE2b-256 | 8b0ece1f1ba05113dc688a1c57d8620a914a33efc10cf8a049052601aaf95d9b |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.450-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | de5037a2172b2ef9ce3379b3a5c801f581ba72bef6d0b75b88281a58ea6117b9 |
|
MD5 | 3c2fedbc2aa78ad2bf6fe9de2f94b1bc |
|
BLAKE2b-256 | 5e1f8337bb61a2f904bbde5889a800061086ecde46f7e7c9ff7da520b99d56f0 |