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.304.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 17498caa76307d33acb2c44cf541dda6edec7502d74b81e684a54831d4563383 |
|
MD5 | 3200bbfa52104f978064a11f14403a59 |
|
BLAKE2b-256 | 7ad66afb2095e891fb63e1a3873466480750b263dc40caa7a639c44d40ff4518 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.304-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 938556d8060a73ce801ae76f8a05f4b0d7f850bc2a49f580ad2e3bc153053cd1 |
|
MD5 | 977226fe9f270a7b57b46b03603476de |
|
BLAKE2b-256 | f1ab74e521d23ba6830a084df8aafb31f4f2b4ac8fa5d33ac981045cfbe90799 |