FAQ

  • GitHub GitHub Repo stars
  • Discord Discord Server
  • ✨ New! Try the OpenAPI Doctor ✨ The OpenAPI Doctor

    All Rules

    All built-in rules have are organised by categories.

    Tags

    Tags are used to organize operations, check they have been used correctly.

    Security

    Are you secure? Or at least have you thought about it correctly.

    OWASP

    OWASP API rules to your OpenAPI specification.

    Descriptions

    Descriptions power documentation, these rules ensure they are not missed.

    Examples

    Rules for validating and checking examples.

    Operations/Paths

    Operations and Paths are the meat and potatoes of OpenAPI.

    Schemas

    Rules for checking schema's and object definition validity.

    Spec Information

    Contract information is critical to understanding context about the contract.

    Validation

    Ensure specific data types are correctly defined.