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.519.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7bdd5997bb58f8d7e98a6967cf2cd9f499054838586176de9c6d5f14253c7474 |
|
MD5 | f2608d2d21b13718439cc4e3a4028b64 |
|
BLAKE2b-256 | cd9bc1882459eb8d0d9f4cf01a4f3567578c15294a9195c874aca83c82723980 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.519-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | de7c6f6b123074af5d58e48178db9aa406679c7cea0c7b1f007d6c0504afe416 |
|
MD5 | 61081179cb5e9dff1c952a61905a2ae3 |
|
BLAKE2b-256 | f1402f4e3b3e5710108c30d88217f21336febf9421537a2cd9290e23f873f820 |