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.831.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1871de0a5a0de6e5028bc55e3b0297b9c35214c43ef2a96ef54ffa7827ff2303 |
|
MD5 | 177e64cecd7fa3ff0acdff9d88e26fc1 |
|
BLAKE2b-256 | e0008910797d31f2025df8d5436241e1116e2625e7bb9f595b3121a7eea1ccec |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.831-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f665cd4aa7818d6522336c51e4379a833efe17d9da141a6d7f685fa02e910649 |
|
MD5 | f0941619ea592c4b4e4bca38e8b82ba6 |
|
BLAKE2b-256 | 7ddee50385a1262384be9981e6ab41c1360c3503a5985132da8d6454bba8444e |