An open-source API style guide enforcer and linter. Why write API Style Guides as lengthy manifestos when you could automate them? Make sure APIs are secure, consistent, and useful. Spectral is open-source but is also baked into Stoplight, with extensions for VS Code and other integration options, giving you real-time feedback wherever you design APIs. Spectral can be used as a generic ruleset engine on any JSON or YAML data but was built with OpenAPI, AsyncAPI, and JSON Schema in mind. Use Spectral rules to target API descriptions for quality improvement or enforce API Style Guide rules, such as naming conventions for OpenAPI models or prohibiting integers in URLs.

Features

  • Keep unwieldy API descriptions under control
  • Reduce decision-making and promote consistent API descriptions
  • Create custom rules to lint JSON or YAML objects
  • Validate and lint OpenAPI v2 & v3.x and AsyncAPI Documents
  • Automated API Style Guides using rulesets improve consistency across all your APIs
  • Create custom functions for advanced use cases

Project Samples

Project Activity

See All Activity >

Categories

JSON

License

Apache License V2.0

Follow Spectral

Spectral Web Site

You Might Also Like
MongoDB Atlas runs apps anywhere Icon
MongoDB Atlas runs apps anywhere

Deploy in 115+ regions with the modern database for every enterprise.

MongoDB Atlas gives you the freedom to build and run modern applications anywhere—across AWS, Azure, and Google Cloud. With global availability in over 115 regions, Atlas lets you deploy close to your users, meet compliance needs, and scale with confidence across any geography.
Start Free
Rate This Project
Login To Rate This Project

User Reviews

Be the first to post a review of Spectral!

Additional Project Details

Programming Language

TypeScript

Related Categories

TypeScript JSON Software

Registered

2023-10-11