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.695.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c1fc89fec8d204b6bae1c9c999d6a8947ee1582b531a044d278f9071ddae1222 |
|
MD5 | afc16ae4e6e7a873c47d3c73f2095f54 |
|
BLAKE2b-256 | ecf4334339d33f5a9ac3567781906a2094e4a8e7b6b6c569cd17e5da512e5ec5 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.695-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 75986867654fd5ac054b791e1bb2fd4629803bde16040bd8ff2d009bab917878 |
|
MD5 | e5603809a747705496bd289ad68095b8 |
|
BLAKE2b-256 | 10076918e17ff498892138d1122ca208b2b41d241f1d75674c60179b99547efe |