Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

sls-apigw-schema-plugin

Package Overview
Dependencies
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

sls-apigw-schema-plugin

1. [Introduction](#introduction) 2. [Installation](#install) 1. [via npm](#npm) 3. [How to contribute](#contributions) 4. [License](#license)

  • 0.0.2
  • latest
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

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

FAQs

Package last updated on 25 Nov 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc