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.406.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fa7afa2101ba2a58b99550218ae02a5ea60d9c710d11ba7de518783531186ad5 |
|
MD5 | 888b6e190b980dcf7382fb86e6318226 |
|
BLAKE2b-256 | fa4dc5e58c5df4c0880ab043e83a22c3c5705117a7291674b44089d1fc04d925 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.406-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 76905d62b690a09e923b3b3490cfaa4b87d2690d0ab775ab7fd6c67206ef83f1 |
|
MD5 | 9a6bfa6ec722a91452bffabb8ba14064 |
|
BLAKE2b-256 | 5bb43289b065eb742049fcf427ce425af71fcdd1e93a615d73ff31e286d7c435 |