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.219.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 074082250aeeeabb98c196f834faf0de7fdf7d9694dd88e45c5f669995d11cc7 |
|
MD5 | e8175d4c1f9fe9a8b8941186c1c6875a |
|
BLAKE2b-256 | 4cbd2d0925a22400aebae6a8db23847b00ae294889e09b233aeca0a64a8c75d0 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.219-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c5a429ba7040301ccf99a7e0b91b11c3a37c4f9b6e8d9f8b1f1a863f52d5d94a |
|
MD5 | 56628b1dbcbf7e987fe8dde8b712ce10 |
|
BLAKE2b-256 | e9cef7dc6b03634254dfcd34cda3d54cf7386a48d2d2b2ff87a99a581f9268ff |