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.569.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f2ed1f334e23d3cc93098a4e6fdcc80267055f52f7d06e8cc130bf4741a61f40 |
|
MD5 | 499d5e0f75a6a804e20b7b5c01ad0015 |
|
BLAKE2b-256 | 37455778679cf23046bb7f77400a479ccdd2311efed82c2de4b7e7f3bf67c879 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.569-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1c74b89314391072afa9491160217508329de17dc1923f414de96b52dec933ab |
|
MD5 | b87e221c0c3de7bf6753e1a98242a265 |
|
BLAKE2b-256 | d53b024b2357c36f3a008892cc2e476bf46b602abab94d8ecedf940cb029bd4a |