Skip to main content

Generating API Documentation with Scribe

Premium
5:48

In this lesson, we will talk about API documentation and how to generate it. This lesson will use Scribe to auto-generate documentation. At the end, we will have a similar page to the image below:


We can install Scribe via composer with the --dev flag because this package is for a development environment. And then publish the config file.

composer require --dev knuckleswtf/scribe
php artisan vendor:publish --tag=scribe-config

By default, Scribe is set to use...

The Full Lesson is Only for Premium Members

Want to access all of our courses? (30 h 33 min)

You also get:

55 courses
Premium tutorials
Access to repositories
Private Discord
Get Premium for $129/year or $29/month

Already a member? Login here

Comments & Discussion

M
M ✓ Link copied!

I was thinking that using comments/docblocks could lead to undesired text in the docs but the annotations override these if they both exist, so happy days.

We'd Love Your Feedback

Tell us what you like or what we can improve

Feel free to share anything you like or dislike about this page or the platform in general.