📘 Validate that an API Blueprint has full coverage over a Serverless config
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.gitignore
LICENSE
README.md
index.js
package-lock.json
package.json

README.md

serverless-apib-validator

📘 Validate that an API Blueprint has full coverage over a Serverless config

Before deploying, this Serverless plugin will parse an API blueprint from the config and validate that every lambda function with an HTTP event is documented.

Installation

npm i serverless-apib-validator --save-dev

Usage

server: your-service

plugins:
  - serverless-apib-validator

functions:
  # Your functions here

custom:
  apibValidator:
    blueprintFile: '../my-docs.apib' # Defaults to apiary.apib
    basePath: '/your-service' # If you have many microservices in directories, you can define a prefix such as /your-service

To validate during development, run sls validate to check your blueprint's syntax and coverage. You can set this up as a pre-commit hook to prevent invalid blueprints being committed and deployed.

Before a deployment package is built, the validation is run and will stop a deployment if the API blueprint is not at 100% coverage.