Documenting your API


These docs are for Scribe for JS v1, which is no longer maintained. See for Scribe for JS v2.

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).


For Express and Restify routes, the docblock needs to be on the route declaration, not the function declaration. For instance:

Excluding endpoints from the documentation

You can exclude endpoints from the documentation by using the @hideFromApiDocs tag in the relevant doc block (on the route declaration). Scribe will not extract any information about the route or add it to the generated docs.