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.605.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 364edb8b0c26a065ee72180b7756accebede9f151e9d4f09674e1d4e966702b9 |
|
MD5 | 8c25e500d43b9cbcffa7f2291a060398 |
|
BLAKE2b-256 | 8a46ffb57d651780fd2fc349c43097720fa22934437739a55d43944d505dbde4 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.605-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 630109604d096225901f22d63ac7bce2d55ae7d0424247a857a384a7ee71838a |
|
MD5 | 698d012951080e6124a1be522af6b3d5 |
|
BLAKE2b-256 | ee1e0b0edbe0fe86de9366fc4f3a32bec2a60f63587ceb696623b2cdae5f2f41 |