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.816.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 336420d1637810de5bb0534ee434812a3c0ee5fb9547dc5a1697c45165f558cb |
|
MD5 | e90f8f780b3b18e88ebc517bcfe12daa |
|
BLAKE2b-256 | eae1f642c4747f2a675162e045f86ce467b9f0c88fb45845912767ba8514299f |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.816-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fe66ec073df12dd68107d9967b6c013d52f0ac7e2aec25de640c0434796152b5 |
|
MD5 | 299e4ed75a5d30eac19cb16786e3c6f3 |
|
BLAKE2b-256 | ff1384e5d2bad91ddd60add977ba8e877837d4f0c4626f7af20942bd309f08a9 |