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.50.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3b883222618732d1a82d84dfcb9773ecfc8a6d7c20efcd6e7516eee69c4196ca |
|
MD5 | d2b2fb7ddce64a21dc86fc070373623b |
|
BLAKE2b-256 | 8025290e93e8013a17d47b5db35c65b66e540fd7c762eb966ef40226bd588a94 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.50-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f7946cad835180a89ba6a3140f46845e514b18b05e5bda028061087ec8dd937e |
|
MD5 | 4758d0d3b39e956b16495bd2eb1b85bd |
|
BLAKE2b-256 | 32401a262c3c671155a02cc6c93f2c50ee08a7102d79442f238221376f850c5c |