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.192.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8fbccc311156ba224ff4728549db04475181201509c37761137ab8ec2371b0b5 |
|
MD5 | b37bc8898ba8fb09690f11f27ec5e911 |
|
BLAKE2b-256 | 053279887afb99abc821e57a8df736457873c398a5353f3c49e2edb79356b6ad |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.192-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb0be1a346e91264785aace81371246eec7685d1f111dbf4e39a00f5d8a819de |
|
MD5 | e82f94615fa4d9c8e5e838804f0a19af |
|
BLAKE2b-256 | 799b8633589fc5e1a47d488aaaf522c0f8e9df0a7147f29aeae689d9f1898684 |