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.181.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6889e2982b62cc5c1334d11f443ef46f5e3c6d3732af8ceb29b6687de4cafc2f |
|
MD5 | b40c0a5fc9e113a17f7015956dee9e56 |
|
BLAKE2b-256 | e1489a113c833471b4a9a302e001b03d731ed84a5eeaaf027c7eb057318bd31d |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.181-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6eb115037b5c877e04834684f1bb1748c4f880a7b3e199e282ee100c409de8f2 |
|
MD5 | 45b94298cf0ce5dbab41eedf7ab67791 |
|
BLAKE2b-256 | 324d7ab6489afe86076b04bd0d3fc9342ef1b1b50ef4d2455ae05f861f50a7c4 |