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.157.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9238b3b4e813960cf4ab12cc31cad4e0e4284fd9e40aaf09ee048bbf3a733bb6 |
|
MD5 | 4ec1c2bea1b6b6accf88cb2d3cccada3 |
|
BLAKE2b-256 | f6b87294ad7009dfe02561910dca4a4f5e185c700cd713806bf7324961387887 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.157-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d21b969c6fdeda45253120366a57196ef60c4033e6c9fdf1cbea431d97434633 |
|
MD5 | 41f290122df3d080c51ea4da54c086ed |
|
BLAKE2b-256 | 130802a2900ad703693f2946f0ea6d219414c468193e2b679932997af014b328 |