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.132.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 61724debe9731334e3be621147eb8eebf565d33d35c18f52130d410c6f9e84db |
|
MD5 | 8c1dc2775cf6d7f6c607b1896da68d1d |
|
BLAKE2b-256 | adee3818e855e382227bf633575a446dc02a99b8303d92558d9e8876f4c4da48 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.132-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3a2a6b18fa899e1e95579a3ba0619063671e784250d254a91b52e4a912fde1cb |
|
MD5 | c4e995753712f914f36ad248b182f649 |
|
BLAKE2b-256 | c98f81cf96c7fb931c282b0ae5f750c95e86e73d2b50388799fed6b487d3e1b3 |