Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Design First Web APIs - OpenAPI 3

Design First Web APIs - OpenAPI 3

Design first web APIs and why Django did not help!

Roger Camargo

June 02, 2021
Tweet

More Decks by Roger Camargo

Other Decks in Programming

Transcript

  1. Backend Data Client 1 API Client 2 System A SDK

    Client JS System B Internet It can be hard to keep an API documentation updated... 👉
  2. /users Code-First, Write Docs "When We Have Time" 👉 It

    means "We will not write documentation"
  3. 👉 It can fail to maintain parity between our documentation

    and our underlying implementation API Specs/Docs
  4. What is OAS3? - Contract for defining RESTful APIs -

    Source of truth for everyone - Open source, evolving standard - Collection of tools - Language-agnostic - Readable by both humans and machines
  5. What is OAS3? - Design by contract (YAML) (The pragmatic

    programmer) - Get feedback on the API before coding - Easier to make changes - One source of truth - Generate code, mock, tests, docs etc...
  6. Automatic live documentation API Mock server Frontend For quick UX

    validation Quick feedback Frontend TEAM Backend TEAM Real Implementation API Tests Business Tests Minimize the ReWork YAML