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.514.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4c4bfa48d34889fba7da643b8025695533547a88665e066063ddc6bdf956bf24 |
|
MD5 | c4ef11f90031779f43cf4a4a763204a1 |
|
BLAKE2b-256 | 9744bcb6190f0ad34c7cf89a72b2d19b5217dda0af1313a7c489e9e6fd57808f |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.514-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 46697466e2ba1817c4b68d4ad92d689cc1dca0d1cf74e3b3de45a35fdedc8488 |
|
MD5 | 3e67c21940b3e5b5b9e8881494c71e71 |
|
BLAKE2b-256 | 00da2303728ead7f33ca215e360667204e70bad7045b63c3f65b9ed3c189536e |