# `mix gen.api_docs`
[🔗](https://github.com/diffo-dev/diffo_example/blob/v0.4.0/lib/mix/tasks/gen.api_docs.ex#L5)

Walks each configured domain's `code_interface` defines and writes a
markdown table fragment for inclusion in the domain doc pages.

Each fragment lists the resource sections, with one row per `define`
showing the generated Elixir function, the underlying action, the
meaningful arguments, and the action's purpose (its `description:`).

## Usage

    mix gen.api_docs

Writes to:

- `documentation/domains/_access_api.md`
- `documentation/domains/_nbn_api.md`

These fragments are intended to be referenced (e.g. via `!include`
pseudo-markers or just kept open in the editor alongside the narrative
page). They're regenerated on demand so they don't drift from the
code-interface declarations.

---

*Consult [api-reference.md](api-reference.md) for complete listing*