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.713.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0d70aa3dbb8a814f3bb122d85bdbc521194436e527b847d453ff529055624fed |
|
MD5 | 3652789033e9f31c934543794bf61bb8 |
|
BLAKE2b-256 | bda8fcb22b575f2031d01d3b38b1b6af3b2e17687d82560fcfb106125d57982e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.713-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a3dddb0a3ce83e789bcea058a19ced831da2bed15674deb9058a3c9774f59d61 |
|
MD5 | 9e7304c7b712bd360258dbf34a46121b |
|
BLAKE2b-256 | b1e41fbf80163181f7254585c0a0f2419e457f4eb82efdefc80df23cc5b64996 |