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.615.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 777e2b383b0799bd40d9d71287c7f09b8a93b1eb6d31c01b2e87ac544362afb9 |
|
MD5 | d0bfce30b5dc21f5eeafc0688eed07f9 |
|
BLAKE2b-256 | b2fb25b6d49fc28ddc6b271eb1a1ded4cdd2fd3a48347b492e38d4c54a330954 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.615-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b826521276a4fc49fce13c9b9651bc0cef3fdd3e3b1a9a5110b463307842eb81 |
|
MD5 | bb7291eb81c049b0eb367f24a064ff51 |
|
BLAKE2b-256 | 3175dc11b337a415a2e763c2e39dd2d63b5fad66207a7e69adab65c346285bf4 |