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.864.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 67b0bde4d491f112852ceb4100453df5f169ee59a54ad884ccca2e637d12687e |
|
MD5 | 8fddd4244e41f9c116e0d272cef31078 |
|
BLAKE2b-256 | c05d90a57233e8b1a3c78c711f884613edd6a23b98e8f6d043e76a525738ac6e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.864-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3b8108e51808c9245fea3bf250b1aa92913bf138d195cd7697727983b4157415 |
|
MD5 | 82c63005089a84e38e0470182a624779 |
|
BLAKE2b-256 | 221a36a39e665de504f41331b7e386af18c4ef1135619610f9f9e48dbac704be |