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.470.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 56cbdeb839298c6f8c5302bbc14c133942eb1321447ad99b43a86518301315f8 |
|
MD5 | 8c51d705dc175b2cbcd8f86e426af5be |
|
BLAKE2b-256 | 34ffa96b8b5e585990455a41077360b2c34a884c0e614f2d575bc512c7b09471 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.470-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0ad3f69189588495eee0cd174a4d5e9de2208bc9107e8c0b0828969b62bb9210 |
|
MD5 | bc74d1a1ade4e0a1f7e43aad245ff49b |
|
BLAKE2b-256 | 228a4fe24f043c21049d9faac60c70c7ca620ff0088a8c92c7b288e60d9135db |