~/talk

The Four Stages of OpenAPI

Talkat Write the Docs Portland 2024 · 2024-04-14..04-16· [api-design, documentation]
links:none on file
slides:none on file

Explains a practical four-stage OpenAPI workflow: convert legacy Word docs into a compilable OpenAPI file, then maintain and enrich the reference forever, plus prototyping and API‑first where code is generated from the spec. Claims conversion routinely takes three to five times longer than writers expect, that debugging OpenAPI is awkward, and that Redocly plus VS Code and Postman are used to compile, run calls, and validate. Emphasizes writers adopt a developer mindset and only edit description tags while code is generated from the spec.

AI-written summary · about

  1. 0:00Introduction
  2. 4:23Great API documentation
  3. 8:19OpenAPI overview
  4. 13:19Stage one: Convert docs to OpenAPI
  5. 27:55Stage two: Maintain and enhance docs
  6. 30:01Stage three: Prototype APIs
  7. 31:07Stage four: API-first approach
  8. 32:59Q&A
~/search
type to search 6,249 conferences, 138,987 speakers and 185,172 talks
~/help
cmdctrl k
search every conference, speaker and series
/
focus the filter search
h
home
c
conferences
s
speakers
e
series
t
light / dark — the status bar button does the same
?
this help
esc
close this, then clear every filter — or just the search, while you are typing in it

Ignored while you are typing. Pages without a filter rail have no search to focus.