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.184.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b614e8c6cd70c9c5d104cbfdd7fa3877c248a6395690884684a7fc1676991905 |
|
MD5 | f38aad522f5876dbfb8a1d511936d594 |
|
BLAKE2b-256 | bf58ba8ef4c12e77a0f0c7238fe7bf117e75ab9c01880742f990b3b16b3c4abd |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.184-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7742b46676fd32aaa9401e64fbeee4e442c20c05d861fd285c0ecfefe3210f7f |
|
MD5 | e783e1a0cabe9e8365131f962b7b5738 |
|
BLAKE2b-256 | 8ca8b91585091dd54758295032e71b5d6067b27bf9309fb25ddd41f7844d0be8 |