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.339.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8274170763b030c4c0c36c1f835dfa460d8e1b425b3d435c088b7257ebfdae23 |
|
MD5 | d6672555ff66cb641f7879ffde036b5b |
|
BLAKE2b-256 | 2bd9089a7c3b78c0d63b1e8aae42c24dae1ce7abd77bccebc3ae714fa67bc234 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.339-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 57712fe53512bb9d2b8d1c11f126b62ef16feda9d9ebe45cdf9fc0454e64bfe1 |
|
MD5 | 1398e088f926624933e68cace6a8a9ad |
|
BLAKE2b-256 | 30d120f0da13117895fdc651c358198d9a5563204df725b65e241be685f6534c |