Skip to content
This repository has been archived by the owner on Jan 24, 2024. It is now read-only.

Integrate with RHOAS API validator #111

Open
EricWittmann opened this issue Jul 16, 2021 · 0 comments
Open

Integrate with RHOAS API validator #111

EricWittmann opened this issue Jul 16, 2021 · 0 comments

Comments

@EricWittmann
Copy link
Member

From Enda Phelan:

While an API guidelines website will be really good to have, a linting/validation tool would be more immediately useful to help enforce those guidelines in real-time while editing OpenAPI files.

Spectral does just this, and can be extended with custom rules, which can be shared to NPM and used in multiple projects.

So @rhoas/spectral-ruleset was published for this purpose. This is still a prototype and we are seeking feedback. This ruleset converts many of the guidelines from service/api-guidelines to rules.

It's quite easy to add to your project, as shown in the docs. Or if you prefer, click here for a five minute video.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant