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.458.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f8c37321377e5eaf58af01186b2affd63d65efd16558df7a35122b76de4f3d8e |
|
MD5 | e9e7e96d2fd05789ae3c7f26aba5dbd8 |
|
BLAKE2b-256 | 2964b1a0b47cdb292b7801955dd2d080840b80295154931bb491adcfb9148f45 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.458-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | df8956891ea481d6267d1f9730626d98ec2f46ad42edcbef009d99175af29c65 |
|
MD5 | acb13ed2d6702c23aa5fad00e31c4c57 |
|
BLAKE2b-256 | 98e5f368bcb1b4176d96f7539ad0d7da5448a85ec7f9967003ec871c59664879 |