What is the purpose of the Host: parameter in Apiary?

Question

What is the purpose of the Host: parameter in Apiary. For example:

FORMAT: 1A
HOST: http://polls.apiblueprint.org/

Answer 1

HOST header states what is the final intended deployment of your API.

It's used on Apiary as an upstream location for debugging proxy, and appears in code snippets as a location for requests.

You can also add suffixes that are then propagated to all resources if you are not running on root or want to version through URI.

Mock and proxy server also emulate the schema you've specified (http vs. https).

Resources:

• HOST in specification
• How it works (see traffic inspector section)
• What's new blogpost (see Pass-Through Proxy section)