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.222.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e93318a1dac21dfbdfe724cf6159419c5a235539212021ead2c853282dcb9e02 |
|
MD5 | 70c9fe1cad86994c94b9286b2f531efc |
|
BLAKE2b-256 | 9bd633d0b11844b9bec5e63e95f4e31ebbb49eb0f274a8e7ae690fa7ca7fbd71 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.222-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 45ff103714b961170eec62c3d8991779fb0f96f533349d479f59a86a58dc47bc |
|
MD5 | 71b2a702ef62c2ce308bc9080987e300 |
|
BLAKE2b-256 | d55bf81cce772f2d32fc15fc41bf573501b607d21e69149746bc56b998022834 |