Last Updated | By Zuplo

API Linting

See how to use API linting to enforce api consistency and require Zuplo features like policies.

Deploy to ZuploView on Github

Zuplo Linting with Vacuum#

How to lint a Zuplo API with Vacuum

This project uses both built-in and custom rules to lint the routes OpenAPI files in this project.

The following custom rules are used:

  • Enforce that routes have a specific Zuplo Policy
  • Enforce that the path of routes starts with a specific value.

The configuration rules can be found in config/api-ruleset.yaml. Custom functions are in /lint-functions.

Run#

To run this sample yourself:

npm install
npm run lint

Recent Examples

example icon

API Linting

See how to use API linting to enforce api consistency and require Zuplo features like policies.

By Zuplo
example icon

Route Custom Data

Use custom data from OpenAPI documents in policies and handlers.

By Zuplo
example icon

Rewrite Request Body

Use a custom policy to rewrite the body of a Request

By Zuplo
example icon

Custom Base Path

Use a custom property on OpenAPI documents to automatically remove a base path and set the forwarding server.

By Zuplo

Designed for Developers, Made for the Edge

Start for FreeRead docs