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.709.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e1432c8f06f1442e28f4bd7e7ba20044abc3c72695a9d2e68df4eed975c7804c |
|
MD5 | 42079d9cfb96c62f92375ecddcc20ba8 |
|
BLAKE2b-256 | 590839b4c86e1679b74d06c3766842df318436e7f97bb0da2f2a2b0384de95ec |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.709-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 54acfd63487052de2c79e9bf1b1c8effa1c51197efac45c033dd0180e0ae4954 |
|
MD5 | 4cf67b30ffbffc3bb6b0a5f08f419ea6 |
|
BLAKE2b-256 | a627c287fbc80abdb2826fc02818db13a9f1efdd52118e4cf341e9fd4e321a56 |