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.381.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 486f84966b5593b55ce15a93a2b863ab31fa8e1854e78c5441558e3fb529eea2 |
|
MD5 | 64a2f59468fae31621e864dd1aeb97ef |
|
BLAKE2b-256 | 8d576de341d05e5b05b8232928ba782464ca00a0261a83883180c0bac5f7ef85 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.381-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4457188258b5f4ed1aa1d825cd15c3fc16b519332b4c404e05780a8a928455e2 |
|
MD5 | 3218e213fa7d0184322dfa666a409ef5 |
|
BLAKE2b-256 | bfb1ffdd877f806eefb04f1286907af2342194b2cd416edaa1c593c0c980f63b |