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.72.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 370e2b42c3110d98a491c5763eb1709b30e1c3f9aff1d5d99ba5f609a2d6b652 |
|
MD5 | e4188744777541a128b5b9aa0ee72394 |
|
BLAKE2b-256 | e4e9bec1892e71d74bd29d6e60bfbff6e97dfc32b8e81f6d80e5187a306a594a |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.72-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e83b57019b000a61cbfc71582197b6abce6759c6e279db75351a94474b6f34e6 |
|
MD5 | b5afb3cb418b01290550041b6d3eb5fe |
|
BLAKE2b-256 | 3b0bbbbb527d351fe0298da01bceea426b8f036062ad69d2f63f59fb6d2ef018 |