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.868.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fd3455a91a90ccf47f1f47caaf599e6678ad57c345a8db9a6c12df1ddb70a428 |
|
MD5 | 92b9c09b81fe22003a23fb8e29cb9645 |
|
BLAKE2b-256 | 6d75daaaffe0bc7eac7f7deee2ec8a20e074f0ddddba735dacc9b27bcffa2f63 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.868-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8f3110d7457ef429e084026f9cf100916892126444db21f76e896cd5d00307ef |
|
MD5 | 42d13edaafdaa38b77976ea75c364965 |
|
BLAKE2b-256 | 7f5f63c3ce23895ec26f836bddf99e4d4c5d8a48784ffbbe14d29acd6ada1a0a |