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.551.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0e96ce1bdbf5a8ef85f7e9f993d7096aa034d7fc13f7ebea5595a4a47ef979c0 |
|
MD5 | bd2247cdd60136c47bfa85cdee594c26 |
|
BLAKE2b-256 | ee9560662b5d5b14afff48c73fdedb79edcfe1b70348993b2ae0b38a6cf2a0f3 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.551-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc52dedee421954768de2bcb4d3640a12b1edbec54087a9000eb1dba438e3ad2 |
|
MD5 | b1ad6e1e9788ca8fe702818c18557112 |
|
BLAKE2b-256 | 89e9448eef47cf244ab2688cafdf01e129a446852371aa99e12d8205be69c098 |