Documenting Laravel APIs
summary
Demo shows a Laravel project (a Chirper API) with live examples and concrete edits that produce usable docs: Scribe generates static HTML and an OpenAPI spec from docblocks and form requests, extracting validation and body examples. Endpoints get query params, grouped routes, and response samples for 200, 204, 401, 422. Generated spec makes Postman collections and SDKs possible and hosting via Bump.sh uploads specs, serves docs and auto-produces a changelog.
AI-written summary · about
chapters (34)
- 0:00Intro
- 1:17Gday Mate
- 2:02Marmite VS Vegemite
- 3:43API Documentation
- 4:01User Documentation
- 5:50Checkmango Platform
- 6:22Great API Documentation
- 7:02Stripe API Documentation
- 7:40Solving Documentation Challenge
- 8:34Open API Specification
- 10:07Laravel Bootcamp Project
- 11:22Implementing API Documentation
- 12:18Grouping API Endpoints
- 13:18Describing Endpoints
- 14:13Documenting Responses
- 15:08Adding Query Parameters
- 15:45Updating Examples
- 16:23Filtering and Pagination
- 17:24Reviewing Index Endpoint
- 17:42Creating Chirps Example
- 18:27Using Form Requests
- 19:08Adding Descriptions
- 19:36Updating Chirps
- 20:34Deleting Chirps
- 21:32Returning Happy States
- 22:16Adding Error Responses
- 23:45Reviewing Documentation
- 24:07Open API Download
- 24:27Lessons Learned
- 25:27Additional Tips
- 26:05Hosting Documentation
- 26:53Bump Documentation Platform
- 27:48Final Thoughts
- 28:18Closing Remarks
related talks
54mDocumenting Laravel APIs
40mCrafting Elegant APIs with Laravel
31mBuilding world-class APIs with API Platform for Laravel
37mOrganizing Code in Laravel
33mThe Tao of Laravel
40mEngineering Complex Applications with Laravel 4
29mLuke Downing :: Lessons from the Laravel Framework
25mWriting resilient code