Documenting the API
In this video, we're going to start documenting our server source code so that apiDoc can generate the content for our API documentation website.
Where to document the API
The purpose of our documentation is to describe the endpoints of our API, including the URL, HTTP method, the request parameters required, the response to expect, and so on.
All this information will need to be specified in doc blocks in our source code. So where do we put all that?
Click to load comments...