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.353.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a0da4432be0ebcbadd683ef9d5b546622af97030c2e9f3fbff76d9bf9f29093c |
|
MD5 | fa79fe729d2b11982362da8f68e9d5cf |
|
BLAKE2b-256 | 02a76c5f72f29ecd55ea53cfbc3a7a3b2d7c3ea382d09fe907415f3f2076481e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.353-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d7f3cd3d4fd99884ac887fe1071ecee698fa10e4b45ec4cc4181d8c937fe91c |
|
MD5 | d829d597c597229dbeee5a9034c3f359 |
|
BLAKE2b-256 | 7b3874ea42b3a1496adcbaf74fced1ff89d77dae35b376ebe904528666c92a7b |