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.795.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 67903b5da31885ddf529b43eecf4f7d3156acb275e2d7b8ecc5c6d449e0c2ebc |
|
MD5 | 34bf92db26bf2185f7ad2352df9a1a5d |
|
BLAKE2b-256 | 9ffd249ba7639184d2c75fb4c971e561fbf5fd094f395a41c3d8145706d04a8b |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.795-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d1a98255f69a018e291c5846d7089541a8f20a8879af600ad3954149955d1a0c |
|
MD5 | 0afb5ee830271a04d60ec75e82d7dde3 |
|
BLAKE2b-256 | 924c395329d48c9a078674de5e9712cc99ff61226ba643b1755c583f7e633c9b |