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.702.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4823c8865492cf78cbe92b1f03b77e3bc4f329400ccfe5be7a529997db994fc4 |
|
MD5 | bdc87523ace2d6efda74185fc7a24fc7 |
|
BLAKE2b-256 | 5ca9c19d489572032d70f207b03b5deb1c92776f2f41bf9b9f4e60e0a417db32 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.702-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 265919394dad7b8336ef7f514d375a88652ee1e648d56dc9d2ab0d17c2e8eb88 |
|
MD5 | 3e37c80b97e07a6aa41f1aec61ecf5d0 |
|
BLAKE2b-256 | 5d85fe2fb6fec75770ada6dfd7e484ddeb192d16116666374e7723355f352693 |