You can use the
@header docblock tag to specify headers for a single endpoint, in the format
@header <name> <optional example>:
The header will be included in example requests and response calls.
Alternatively, you can specify headers for multiple endpoints in one go by using the
apply.headers section of the route group in
.scribe.config.js. For instance, with this config:
All endpoints that start with
v2/ will have the header
Api-Version: v2 included in their example requests and response calls.