Flat HTTP API Documentation

Peter Hilton

Lightning talk - in English

The way we write API docs is highly structured, natural to programmers, and wrong. HTTP API documentation typically looks nothing like the requests and responses it describes. This creates extra work for the reader to understand the documentation structure, and figure out how to translate that to code. It also makes it harder to spot bad API design. Instead, you need more readable documentation that doesn’t waste your time.

 

This presentation introduces Flat HTTP API Documentation (FHAD) - a better way to write document the HTTP API for all of those microservices. FHAD leverages HTTP’s own structure together with some layout and typography to document API/ by example, in as much detail as you like. You will learn to see API documentation in a new way, which you can use immediately to write more effective documentation with less effort.