Configuration
.specbook/specbook.config.ts holds:
| Key | What it holds |
|---|---|
project |
The project’s name. |
vars |
Defaults for every environment, such as each API’s address. |
environments |
Variables for one environment, and a risk of production or sandbox where the name does not say. |
services |
{ spec, baseUrl, auth } for each API. baseUrl is a template like '{{petstoreUrl}}'. |
timeoutMs |
How long a request waits for an answer, in the CLI and in the browser. Default 30000; 0 waits as long as it takes. |
auth |
Profiles that apply a credential, such as headers built from {{secrets.NAME}}, or an OAuth flow. |
secrets |
The secrets the project uses, by name. |
faker |
{ locales, default }, the locales generated values can use. |
branding |
The name, title, tagline, logo, accent colors and links of a published site. |
codegen |
outDir and importPrefix, if the defaults (.generated and #api) do not suit. |