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.275.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 32aa827cfa9bd3f0753718a7a19da2e836b5bf01a0fe1c0959c4b5660596fb09 |
|
MD5 | d7c11a35fc2005cd02a93e275d24d3c4 |
|
BLAKE2b-256 | f778149bcfa95d5f6c3d38a2b55a0e54f26663dc2db94344ae654aced9f6436f |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.275-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fc07b9bd6a9d0b022d5225c6216983113d8f415cd4a6e8470dbfa925d0dfaea0 |
|
MD5 | f5dd6a06e0deb129857d6583b2d72df6 |
|
BLAKE2b-256 | 766bda5794f980baa99708b114fa0893f8dabc4f2bfd0aefe705194f54086071 |