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.787.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4d9eddebf84367d2bcfff737aa459c8aa047914785b03a9f41436a89d6717670 |
|
MD5 | d39ef64c2f565ed62cb38aeca186f04d |
|
BLAKE2b-256 | 70f3a23db46ce6290b7ebbae78297152790a32756e15c58e89381894885075f2 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.787-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6023e8d40f43f225acac2b992ace9d692ba53564cc6492fbcdc5165b3999a2d7 |
|
MD5 | f46edf68b0f8d1f78a10839cbd5c51e7 |
|
BLAKE2b-256 | 6fa6d92d3faaba4bb13fa72825841483f894c636058d5251e0eedb3eae1110b0 |