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.904.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 135fea78169c4bc2415a00e8365a9d275363670689fcc47c22683ea347d0988a |
|
MD5 | 0c5788bfc8e6321375a85accc573b9b8 |
|
BLAKE2b-256 | 291736bd93fb98cba4cf0031df7fe68324feda79920c7e96d2a66abd9c471064 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.904-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 365a7c6a66fb373c4ac5a05556800faaa0ee6978964092d3159ea00a4307f9fa |
|
MD5 | fe3fd106d695838bbfd7b1a98d815655 |
|
BLAKE2b-256 | ba5e9b1d33d19849d59be64b702581572fa37781eec86b885553e501b0caa975 |