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.27.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 245ac4a037a68058b32e058ea832b105a53adb7638e824bc6cbfaffb72257141 |
|
MD5 | 42ab03eb4697a625ff331bf0c95525da |
|
BLAKE2b-256 | 295f6997d771374695e9f40bb4e8e948695c3bbf749fbb2b3f3c9fe44dffcad5 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.27-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 57e4e056b636194f4cd48676be9164c3791c7aa4ac7153ba5176d8bbe7a11781 |
|
MD5 | 050a0bdf6f77cab4b290d862413e947a |
|
BLAKE2b-256 | 552b3753f5680c7875db5ec2eeeb58fab653c6bd49243c1a0ea32d65a6ab1e4c |