@sumup/sumup-api-style-guide

SumUp REST API Style Guide

A spectral ruleset to lint your API specs against SumUp standards.

Get started

Install Spectral

npm i @stoplight/spectral-cli -g

Usage

You can specify the Ruleset directly on the command line:

spectral lint -r https://unpkg.com/@sumup/sumup-api-style-guide/dist/index.mjs <api definition file>

Or you can create a Spectral configuration file (.spectral.yaml) that references the ruleset:

extends:
  - https://unpkg.com/@sumup/sumup-api-style-guide/dist/index.mjs

Example

spectral lint -r https://unpkg.com/@sumup/sumup-api-style-guide/dist/index.mjs petstore.yaml