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.924.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 51cbec4486aec1872419fa79fe75838828fc7b531e30a48b25f458ad7f33fedd |
|
MD5 | f04422db63e6e39c0a7ad8ee9cfdb416 |
|
BLAKE2b-256 | f1f4a9bc61c181ddabe248aede30ca29748152b473130817ee8412c4ef3d228b |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.924-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c3bfc1bdd6167aa9426ba635926b31a9f6e7387fe265979a95d00de13a0d7cba |
|
MD5 | 3e132cc200f3697de96c3c4f58af5f30 |
|
BLAKE2b-256 | 5cea09b2a5382a83a788e145198259c67f85bab2ed6f6f3b8d0c0cb3940b9e13 |