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.390.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | effbf32bde81ac5b2cab70d659914a1f6baca79eb7fe3b99c334efbf8a246c59 |
|
MD5 | f314398a7f51ad5d9796f6f4322ca748 |
|
BLAKE2b-256 | ac812dec4ad416c39713564883797853bea691929ebd723276f17187b333dd37 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.390-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3b8de6ddb7aae290ef41f7f6b119b1da8707a3eb83659080fb7726da74529369 |
|
MD5 | 91a09c4945e87b86c7b9f329cbd0eeab |
|
BLAKE2b-256 | 8d4c60f007ac5e292390e004e93a96d366d4e5bcb6b52bf51f37a23f86b607c5 |