Skip to content

Tooling to improve adherance to government guidance and standards for APIs

License

Notifications You must be signed in to change notification settings

mccleanla/api-standards-linting

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

API Standards Linting

Linting tooling to automate the verification of APIs against a set of accepted standards, such as API technical and data standards.

This repo aims to cover any standards expected of public APIs produced by UK government.

What is API linting?

API linting tools check programmatically that OpenAPI documents follow a set of rules, for example that each request you define should document what a successful response looks like.

This tool uses Spectral Rulesets, which validates OpenAPI files. We have added our own rules to the existing Spectral rules.

About

Tooling to improve adherance to government guidance and standards for APIs

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%