Documenting your API

Scribe tries to infer information about your API from your code, but you can enrich this information in the config and by using annotations (tags in doc block comments).

Here's some of the information you can customise:

General API information
Endpoint metadata (endpoint group, title, description, authentication status)
Headers to be sent in requests to the endpoint
Query parameters and URL parameters to be sent in requests to the endpoint
Body parameters and files to be sent in requests to the endpoint
Example responses returned from the endpoint