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.783.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5185295fd00af6fc79a151e31b117fbd3c7e6704753191f6b03263c5f3f5f9f4 |
|
MD5 | 9198ebfc12e63c7e8b129d1b657f451d |
|
BLAKE2b-256 | d743e94f5002f589d82c7f10702e603ff0344dcf4d7d2361c7e452dd5d5f9c45 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.783-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1bfd552bc1f29cac4bdc3cf1adbfb709d090aa72067667ea7b4479a8422dabe1 |
|
MD5 | e8d6f7242eea46d204d43965115c7bb8 |
|
BLAKE2b-256 | fd9e8cbea6002f28745deecb569820a89ce8bffe2ea1ad98410fd0f1973c6f7b |