sls-apigw-schema-plugin v0.0.2

Table of contents

1. Introduction
2. Installation
   1. via npm
3. How to contribute
4. License

Introduction

The goal of this project is to provide a simple and easy way to document APIs. Additionally, this plugin will help you to define your models and use them to validate your requests. This is opinionated and not meant to be a generic documentation generator.

There is a critical note about the JSON schema: API Gateway models must use JSON schema draft 4. This is not a limitation of the plugin, it is an actual requirement by API Gateway.

Installation

Via npm

npm i --save-dev sls-apigw-schema-plugin

Documentation entities

The following entities are supported by the validator:

• API
• RESOURCE
• METHOD
• QUERY_PARAMETER
• PATH_PARAMETER
• REQUEST_HEADER
• REQUEST_BODY
• RESPONSE
• RESPONSE_HEADER
• RESPONSE_BODY
• MODEL
• AUTHORIZER

How to contribute

Please see CONTRIBUTING.md for more details.

License

MIT