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.597.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9ab1a170f4e7cd543afa7be157cefbfbac3436d22b85ee1b042ad8092679929a |
|
MD5 | dd29c74bacd3d47597d68360e6f4b4df |
|
BLAKE2b-256 | 55ef3b136dad58dd411ee7275620e600a7afd76492bc61273dfd04fc9f6dc0eb |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.597-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b129bad3e350d380295f6685945107470478691696bfaaad53114cf3682ba353 |
|
MD5 | 94bbc8ae6ddd18cef9544341d0e41962 |
|
BLAKE2b-256 | 259ad8e8b0cd033027f77288ea1a5c5290c8a6bee028cc79c04532623a3ce561 |