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.842.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5a2a271d96f12de4de83416c21a711c3afbe2672a99cee4dd5353ad85d7de5c0 |
|
MD5 | 1649999728b44120ab292a5d78702ac9 |
|
BLAKE2b-256 | 7c8b3f242a85bbb9fb07443233a7daee46f0c1a7b367841083507b34ac7ba257 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.842-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 92bd12afdac84b1a1b615516b601a27e2a557c500f7f229b03e653e08bc7b97c |
|
MD5 | 24a08d124caba0cf37396244b7d397c2 |
|
BLAKE2b-256 | 13f23daae6adb39b9fbfe125714fb0cba03bfd40fdcb4f62247a6491c44afb74 |