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.111.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7961454c9eb18e3127c465affd66bd3edf5fc7560b7ac33efbe7cb4b1985ab0e |
|
MD5 | 317a1e3d93cba4c126b7a1cb030ced75 |
|
BLAKE2b-256 | a0251da854a59b9d9e15a1cc40e3810c759a6fc18bf34c094465bc7dad7e528e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.111-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d157adf2d6a4d40e15192be22b9b2fb9bf90fa204bee186a72987a328d4b01bd |
|
MD5 | d26b9fa21b0a74538116a19d93eef02e |
|
BLAKE2b-256 | 61dd31cca5f8362a737de9998459dd62a2b6bd7fee89307943599ae21271f0c3 |