Is there a best practices to document an API for public?

Posted 11 months ago by malhayek

I have an API that is written on a top of Laravel 5.5. I need to write some sort of documentation for it so people know how to use it.

Is there is a best practice document that I can use as a guide to help me writing the document?

Is there an API example of a Laravel project with document that I can look at? Or is there a standard documentation template that the community use with Laravel based APIs?

Please sign in or create an account to participate in this conversation.

Laracasts Mascot

Hi, Have We Met Yet?

Did you know that, in addition to the forum, Laracasts includes well over 1000 lessons on modern web development? All for the price of one lunch out per month.

Sign Me Up

Channels

Reply to

Use Markdown with GitHub-flavored code blocks.