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.280.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7ae4c38666d26cc13038aade6ae9ae1f59cb0af5a2d045b06b47843150033dab |
|
MD5 | d171f0a6ab36fba112b405832421e3fd |
|
BLAKE2b-256 | 13855a785c81a50c3b7b8a6edad642bd7b606434ff59f3fabb34ebe783af2457 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.280-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | baa1297db86f6787d6db16d3f0c8c785b865eae947b3b3bda724d366b4ee71eb |
|
MD5 | dbd1693f183449087ae35f65852f4545 |
|
BLAKE2b-256 | 21862f1831e6edb37b568affb83a202334a6a0028ed7ab6372ce0c5cf659a4e1 |