Documenting Laravel APIs
summary
Demonstrates that Scribe generates human‑readable API docs straight from Laravel controllers, form requests and API resources, producing an OpenAPI YAML plus static HTML and example code snippets; shows extracting validation rules and examples from factories, adding query/body parameter annotations, documenting 200/401/422 responses and a 204 delete, and enabling try‑out snippets or hosting the output as static pages. Scribe generates docs from Laravel code and response samples from factories and form requests and the generated docs work end‑to‑end.
AI-written summary · about
chapters (16)
- 0:00Introduction
- 3:22API documentation matters
- 8:20API documentation challenges
- 10:27OpenAPI and Scribe
- 13:18Scribe with Laravel Chirper
- 16:14Basic API docs
- 18:42Grouping endpoints
- 21:11Query params and responses
- 26:28Request body and validation
- 31:28Error responses and edge cases
- 36:58Scribe and OpenAPI config
- 41:38Scribe benefits
- 43:02Hosting API docs
- 45:12Q&A
- 46:36Q&A
- 50:38Q&A
related talks
30mDocumenting Laravel APIs
40mCrafting Elegant APIs with Laravel
31mBuilding world-class APIs with API Platform for Laravel
30mGenerating docs from APIs
35mOpenAPI for Documentarians
27mGetting developers hooked on your API
37mOrganizing Code in Laravel
38mZen And The Art Of Automanually Creating API Documentation - An Inquiry Into Process