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.333.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fc31f8e4489478e801a902f07681c5d3f89c2ff839d7f42444bf84ceea7404c9 |
|
MD5 | 187093136573475a404fcec240dbfe7b |
|
BLAKE2b-256 | 2c2dd75cb4f48374a23741f5031a60e9f8d633533e816413b8b96c88b8352250 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.333-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1fd7d4a5dda61c103f7d4022f05e088ed27fbb33577fc0c5dd5623b6701cd268 |
|
MD5 | 3c914e447f2d6b11adedacd93797d4be |
|
BLAKE2b-256 | b3b77c547a137417e7f2354f6eb4da511d2ba5628d451623598677f92617a989 |