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.836.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9ed13e599736f23eb3d29b3c0b69e5d9fcca827b5d99670997a3d7868e0b43ed |
|
MD5 | 5f7e0fa0ef8d4d6eff680d9cd4cca030 |
|
BLAKE2b-256 | d60b3baac0c4ceb3cea57b5ca348724f19c209cf4e7b930a7285a68478ddbe73 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.836-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d3651a01d2be56329e83d87ffc067b5ed081108bfe214590fab55f48fa23ff78 |
|
MD5 | 54b420f1da3b27a693fb53a5eb3ea71e |
|
BLAKE2b-256 | bb79208ffc6526872d7e009584b8c60b306e754837fa45bf6de1a52f4162bce7 |