010PHP: Flat HTTP API Design (and documentation)
13 Dec 2018
Flat HTTP API Design (and documentation) ~ Peter Hilton
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 document your HTTP API. FHAD leverages HTTP’s own structure together with some layout and typography to document by example, in as much detail as you like. Attendees will learn to see API documentation in a new way, which they can use to write more effective documentation with less effort. You’ll also get a REST API design checklist that you can use to either document or avoid design mistakes.
We are hosted at the FRMWRK office which is located at the Schiecentrale. A QPARK parking garage is located underneath the office and FRMWRK will provide parking passes.
FRMWRK is a no-nonsense and down to earth internet agency in Rotterdam. Their teams of Magento, Drupal and Online Marketing specialists work with their clients to achieve the best results for their websites and webshops. With great success.
18:30 – 19:30 – Doors open and food!
19:30 – 19:45 – A word from our organizers / location sponsor
19:45 – 20:30 – Flat HTTP API Design (and documentation) ~ Peter Hilton
20:30 – 22:00 – Round up and start of Social!