scratch Using an API Design Library Linting API definitions from the beginning of the writing process Using Contract, Content, Variation and Integration Tests Deploying API Definitions to specific targets Using pipelines to automate the things Observability
description: Info section has to include a title as identifying name of the API. given: $.info severity: error then: field: title function: truthy include-version: description: Info section has to include a version following semantic rules. given: $.info severity: error then: field: version function: truthy valid-semantic-version: description: Versions are restricted to the format <MAJOR>.<MINOR>.<PATCH>, e.g. 1.0.0. See http given: $.info severity: error then: field: version function: pattern
known as the "happy path" With variation testing we have the happy path and the unhappy path With the unhappy path we want to verify that the API response is matching with the expected error response