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.95.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8ef0c9bf3da0778a6cb9744543c196dc9d42b8b19e430162e0cbe3f3bec213d7 |
|
MD5 | d20a7f17604106214c224b76ab3b01b2 |
|
BLAKE2b-256 | 001792397efc85b2e072c5fbdb013f64d162bbd97c9e5a2333ed8976a2ed2ffb |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.95-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 365a605e47843316f293962b2eb3aa9cd680cf13d8ed8fd8fc7af9eb03eb575b |
|
MD5 | ee95043a4df453b9bca2919b93614d64 |
|
BLAKE2b-256 | 5e882d9b001014871c642d19fde0628770a78ceaa0b625cc3bf5b10dfa376c6c |