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.720.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0dc512c4d6f5ee63a5667dde800b7c5bedd7a12b0db0156274a43bda8bf5d929 |
|
MD5 | 964a8e759413eaaf9e95bb78bf93cf0d |
|
BLAKE2b-256 | 42259d687ebcb7f8097785417de7cf25d7ea7e0e9f9d5b42eca7fd3d11549a9e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.720-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4588d96af044b982a05a3fe5a2e3ca6b8c564c96c55699cb8667ab6abaa9bde0 |
|
MD5 | f538a8f00da261d579f8735f3b4882b6 |
|
BLAKE2b-256 | 81bb75b1a15c0e461f38db5367e2cf9f40d4913d2a9b3357c24a8672ef96faac |