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.246.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3b1a4db902ce7620158210e8273956c2b5fdab8b6ed29e9a1e3c9c70953542d9 |
|
MD5 | c48ba0ee67c8491de96d01cfb557d9c4 |
|
BLAKE2b-256 | ad7a28608f827bce7a21680644f7b45341e899e5a796073f52fd354a97967dac |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.246-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 009389b724a1bdc951e25ae3c947f84df08ae3cc3bae081f65f464e010a17b63 |
|
MD5 | 8a76b77d790c935cd0be1645fe2cc6bb |
|
BLAKE2b-256 | a2a2999c6622b4d97acbf2542c95f960a087339c902b3104ff7cd7d4403b15f3 |