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.134.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2034cd96eb0dddeefb131141283b965ace52dcaf85be10ffd8dbad3974bdc21f |
|
MD5 | 5a322cb8d54a5403ad654727d1fcf46a |
|
BLAKE2b-256 | 03044e1774d23d9c3885d75409965b920ea31abe4802624d5530d938b15dd3aa |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.134-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b7ac21e57175b0718984297d3ad9b9484b44d1e8e92ec855384cc313655ae45b |
|
MD5 | 2f72f4cc385ee963d5cbf9d914c71169 |
|
BLAKE2b-256 | 924e362077b64f521ad455df0e3a514c42887ffa0ff2fdab297e7bcccb4b5676 |