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.852.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dd19223450c3580b7298b3de7d97b5c390a7cf37e44034c3be9002f06e337686 |
|
MD5 | 09cb165d8aba351d482b4cc262b8f9c6 |
|
BLAKE2b-256 | 14cb3df745e36b2a66b4ec8de986b06a8dccef914fe9700a73954853dd32c24a |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.852-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a93605f0f88b02b12aa8cd7520b2801be3b408efd36b375d2ca8cd95bc85a270 |
|
MD5 | ba0f4903de0f662d25906fc874c88612 |
|
BLAKE2b-256 | ee12d8be671e9986a2db3d8b9469eb58b40e6b16d82a9ab49281f32321aa2283 |