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.714.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7c4044a42c9b67efde2a5c144a89ff3edc874754aa63bcdec8501d0df2b9322f |
|
MD5 | ff65141481eceb0c49e497d845b56639 |
|
BLAKE2b-256 | 070db6274a7b9d41368012447bedde2a3699f4101f41c87394b8ec56e3be478c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.714-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0b03b2176876fa5b621f56b768cda2d31d460fa9d7e6d5f5dac745aceb664e0e |
|
MD5 | f2780fb4e98c2c95433f6f7d0176b2b7 |
|
BLAKE2b-256 | 9d12c19f33d3016bb4c80bd015b431d829415a2788105046322ea7fbee2c34e4 |