Skip to content

fexapi generate

Reads your schema.fexapi file and compiles it into the API spec used by the server.

Usage

bash
fexapi generate

What It Does

  1. Reads fexapi/schema.fexapi
  2. Parses routes and field definitions
  3. Writes fexapi/.cache/generated.api.json

Output Files

FilePurpose
fexapi/.cache/generated.api.jsonCompiled API spec — the server reads this

The command compares the current schema signature with cached output and skips rewriting when unchanged.

When to Run

Run generate after every change to your schema.fexapi file:

bash
# edit schema
fexapi generate
fexapi serve

TIP

If you use fexapi dev --watch, generation runs automatically when watched schema files change.

Errors

If your schema contains errors, generate will print them and exit with a non-zero code:

Unknown type "integer" in field "age". Valid types: number, string, boolean, date, uuid, email, url, name, phone

Released under the MIT License.