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.384.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bd49cf8021c6f1cd802322d0b874ca236af94656239e36d7a7fc6601ffd89838 |
|
MD5 | add7a6e4999a75bbb95cb69d84e87815 |
|
BLAKE2b-256 | cfbd547d67ad338c46220ea8be1a48b2be47814a8891a7fd1104cc880737c1ac |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.384-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d8de6e65822c67a1682e24d94727239dc3a14b41ccd12f40110fe2af78ef0934 |
|
MD5 | 77fc20be00b5e261c994045aeb7f4c7e |
|
BLAKE2b-256 | 3dcd57677e4ad99b18ee488d0f9a88f62588545519f9132958727dc2d11cdfe5 |