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.726.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9e14378754fae05e15dcf000ff83f83749fd45f5e79fd83f10b7264eb53ca9a9 |
|
MD5 | 2fa417922fb3ecfbb43202812bc54fa8 |
|
BLAKE2b-256 | ea43cbd4f379242f4bb94d5f1a79c8d6d94b1879a56d5732c8c4edf782e7c7e9 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.726-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0b77ae82d9e0dd21e7027ac96ed542be2af81c74bb79cd6a9723921b40a86848 |
|
MD5 | 29a3a6b984223a68f47784fae003a892 |
|
BLAKE2b-256 | 78ff51d0495dd4a18cca9e449c874570bd5e9cee91ccd13aa39c930e01161af9 |