James Brooks - Documenting Laravel APIs - Laracon AU 2023

Tune in as James, a software engineer at Laravel, shares his expertise on API documentation and makes a playful case for why Marmite is superior to Vegemite. 00:00 Intro 01:17 Gday Mate 02:02 Marmite VS Vegemite 03:43 API Documentation 04:01 User Documentation 05:50 Checkmango Platform 06:22 Great API Documentation 07:02 Stripe API Documentation 07:40 Solving Documentation Challenge 08:34 Open API Specification 10:07 Laravel Bootcamp Project 11:22 Implementing API Documentation 12:18 Grouping API Endpoints 13:18 Describing Endpoints 14:13 Documenting Responses 15:08 Adding Query Parameters 15:45 Updating Examples 16:23 Filtering and Pagination 17:24 Reviewing Index Endpoint 17:42 Creating Chirps Example 18:27 Using Form Requests 19:08 Adding Descriptions 19:36 Updating Chirps 20:34 Deleting Chirps 21:32 Returning Happy States 22:16 Adding Error Responses 23:45 Reviewing Documentation 24:07 Open API Download 24:27 Lessons Learned 25:27 Additional Tips 26:05 Hosting Documentation 26:53 Bump Documentation Platform 27:48 Final Thoughts 28:18 Closing Remarks