Courses

Build Laravel API for Car Parking App: Step-By-Step

Generate API Docs

One of the most important but overlooked things is to document your API for future clients, whether they would come from a JS front-end, or a mobile app. Things like:

  • Endpoints
  • Parameters
  • Auth mechanism
  • Example responses

Luckily, there are a few Laravel packages that allow you to generate such docs automatically. You configure things you need, by modifying the config file and adding some comments to your routes/controllers, then you run an Artisan command, and it saves the static HTML files to a public folder on your server. As a result, you can just send the link to it, to your API consumers.

My personal favorite package for this is called Scribe, and we will use exactly that one.

The full lesson is only for Premium Members.
Want to access all 10 lessons of this course? (55 min read)

You also get:

  • 73 courses
  • Premium tutorials
  • Access to repositories
  • Private Discord