Documentation coverage
What this site documents, learning paths, and scope
This site is the backend reference for ApiTables (storageitsolutions/api-tables). It does not replace the Next.js Frontend docs, OpenAPI exports, or product-specific runbooks.
Learning paths by experience
Junior developer (week 1)
Goal: understand the system and ship a simple read-only table.
Day 1 — Concepts
- Key concepts — server-driven UI, three phases
- Glossary — bookmark this
Day 2 — Hands-on
- Getting started — install, config, first table
- Test with curl — both
load-tableandquery-table
Day 3 — Contract
- Table structure — what frontend expects
- Data flow — follow one request end to end
Day 4 — Enhance
- Columns overview — add a column
- Filters — add text search
Day 5 — Support
- Troubleshooting — common mistakes
- Pair with frontend dev — compare network tab with your curl output
Mid-level developer
Goal: full-featured tables with actions and scoped access.
| Topic | Page |
|---|---|
| Middleware per table | Guards and middleware |
| Row actions | Row actions |
| Bulk export | Bulk actions |
| Dynamic filters | Filters — bindings section |
| Params scoping | Data flow — params passthrough |
Senior developer
Goal: extend the package, optimize, integrate with infra.
| Topic | Page |
|---|---|
| Package internals | Package map |
| Email report pipeline | Email and exports |
| Custom export class | Bulk actions |
| Performance / N+1 | query-table |
| Constructor / instantiation caveats | Troubleshooting |
In scope (backend)
| Area | Docs | Source |
|---|---|---|
| Concepts & onboarding | Key concepts | — |
| Install & publish | Getting started | Service provider |
| Package layout | Architecture | src/ |
| Configuration | Configuration | api-tables-config.php |
| HTTP API | Endpoints | Controller, routes |
| Table authoring | Columns, Filters | TableAbstract |
| Actions | Row, Bulk | Action classes |
| Export & email | Email and exports | GeneralExport |
| Debugging | Troubleshooting | — |
Out of scope
| Topic | Where to look |
|---|---|
| React / Redux UI | Frontend ApiTables docs |
| App-specific tables | app/ApiTables/* in your Laravel repo |
| DB schema design | Your team's migration docs |
| Package unit tests | API-Tables-Lib repo (if added) |
Before you publish docs changes
- Run
pnpm types:checkandpnpm buildindocs/ - Spot-check new pages in local dev (
pnpm dev) - Verify code samples match current package API (filter constructors, etc.)