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.676.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | adb1c5827c5acb7b145a799ab43142e775db8c394f271e6e6844fc664a65d966 |
|
MD5 | 16461f8eb4b5c0fc0fe7812051a736e6 |
|
BLAKE2b-256 | 0582dafc7d9aacf16d02d45b90ead3a1b3316c29cc7caf82ff76bd5abbc5eacc |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.676-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | adc192265794b16d2a43f9600d0f807195ccd0090d4a1b7f756f18f6718ef5e6 |
|
MD5 | fdf42691f68e058ed723e65787b32277 |
|
BLAKE2b-256 | 5c866a1c909a7befdbbfaf2acb2a0ffb4b2e07579c00ef08cfbe704406cc2953 |