name: make-app-service description: "Use when generating, refactoring, reviewing, or debugging Make App apps/service API code and UI-Service contracts. Covers Service route design, apps/docs/api.md, layered source structure, make-client adapters, schema normalization APIs, record CRUD through Make gateway /make/data/v1/record, record list filter parsing and { expression } pass-through, user/department/lookup/file proxy APIs, Make adapter config, request login-context forwarding, validation, logging, and Service API tests. Does not cover UI layout, auth implementation, build output, runtime, DSL modeling, Make CLI deployment, or canvas-table internals."
make-app-service
Use this skill for Make App Service API work in apps/service.
make-app-service owns the Service API contract between apps/ui and apps/service, thin Make Data API orchestration, Service route shape, Make adapter runtime config semantics, request/response normalization, Service-side validation, error mapping, boundary logging, and Service API tests.
It does not own UI layout (makeui), authentication implementation (make-app-auth), runtime build/start contracts (make-app-runtime), DSL modeling (makedsl), Make CLI execution (makecli), or CanvasTable rendering/editing (canvas-table-integration).
Quick start
- Inspect
apps/docs/api.md,apps/service/src,apps/service/src/config.tsor host-equivalent config entry, existing tests, and the host project's declared data flow. - Preserve the host API contract. Update
apps/docs/api.mdbefore or with any Service route or response-shape change. - For Make Deploy's default route split, treat published browser-facing Service routes as
/api/**. Prefix-free/app/**,/auth/**, or/healthroutes may be local compatibility only; do not document them as the published UI contract unless the deploy route actually exposes them. - Keep Service thin: validate UI input, normalize request/response shapes, call Make adapters, and return stable UI-facing contracts.
- For a new Make POC Service, use the ExpensePoc-style layered source tree by default:
app.ts,server.ts,config.ts,logger.ts,make-client/,services/,utils/, with tests beside the route/adapter/helper they cover. - Do not read local DSL/YAML as a published runtime data source. Runtime schema and data come from Make/backend APIs or the host Service adapter.
- Use shared adapters for Make Meta/Data calls, candidate APIs, lookup, files, and schema normalization. Build Make adapter URLs and
appKeyfrom normalized runtime config, not from route-local domains or UI input. - Add or update Service tests for every changed route, adapter, validation path, and error path.
- Read only the needed reference files from the map below.
Topic reference map
| Task / topic | Read |
|---|---|
| Service route shapes and UI-Service response contracts | references/service-api-contracts.md |
| Service folder structure, layering, logging, errors | references/service-layering.md |
| Make Data API adapter rules, schema, records, files, lookup, candidates | references/make-data-adapter.md |
| Test requirements, contract checks, safety review | references/testing-and-safety.md |
| Auth proxy, cookies, unified login, 401/403 behavior | Use make-app-auth |
Service build output, port 3000, dist/server.js, package scripts, publish readiness |
Use make-app-runtime |
| UI layout, forms, detail display, visual states | Use makeui |
| Make field/table rendering in CanvasTable | Use canvas-table-integration |
Scope boundary
make-app-servicedefines Service-owned app APIs such as schema, records, candidates, lookup options, file proxy, and thin custom orchestration.- It may document route names, query/body shapes, response envelopes, and adapter behavior.
- It may define Service-side Make adapter config semantics and environment variable names used by Service source, such as
MAKE_APP_KEYandMAKE_API_BASE_URL, while leaving deployment injection to runtime/operations. - It must not decide authentication implementation or OAuth/session mechanics; those belong to
make-app-auth. It may still mount and document the App Service auth proxy path required by the host contract, normally/api/auth/**for Make Deploy Service-fronted Apps. - It must not decide build output, Service port, Docker/K8s entrypoint, package scripts, workspace manifests, or publish readiness; those belong to
make-app-runtime. - It must not define business models, entities, field meanings, relations, or DSL YAML; those belong to
makedsl. - It must not decide UI layout, component choice, Drawer layout, or CanvasTable rendering; those belong to
makeuiandcanvas-table-integration. - It must not hard-code environment-to-domain mapping. Make API base URL, gateway routing, and secret injection come from runtime config, backend/operations, or Make tooling.
Default Service responsibilities
Generated or refactored Make App Service code should provide these capabilities when the UI needs them and the host project does not already have equivalent routes:
- public health/config:
/api/health,/api/configfor published UI access;/healthmay exist as local or k8s-probe compatibility - runtime schema:
/api/schema,/api/entities/:entityKey/fields - records: list, get, create, update, delete, cell update
- lookup options and safe lookup relation updates
- user candidates and department candidates
- file upload/delete/download proxy
- thin custom orchestration when requested, for example OCR result creation
Keep route handlers small. Put Make/backend calls in adapter modules, cross-route business orchestration in services/, and pure schema/value helpers in utils/.
Hard rules
apps/docs/api.mdis the UI-Service contract source. Do not change Service route behavior without updating it.- For Make Deploy Service-fronted Apps,
apps/docs/api.mdmust document published browser paths under/api/**, for example/api/auth/**and/api/app/**. Do not document prefix-free/app/**as the published path unless the deploy HTTPRoute exposes it. - New generated Make POC Services and non-trivial generated/refactored
apps/servicecode must use a layered, componentized source structure instead of flat route/adapter/helper files. For new Make POC Services, default to the ExpensePoc-style tree:app.ts,server.ts,config.ts,logger.ts,make-client/for Make/backend adapters,services/for multi-step orchestration,utils/for pure helpers, and colocated tests. - A flat
apps/service/srctree is a readiness defect for generated POC work when it mixes route registration, Make request construction, schema normalization, lookup/file orchestration, config parsing, logging, and helpers side by side. Split it before reporting the Service as complete. - Route handlers in
app.tsorroutes/only validate input, call a service/adapter, map errors, log safe boundary context, and send the documented response. Do not put raw Make payload construction, schema variant parsing, record lookup orchestration, file proxy mapping, or custom workflow steps directly into route handlers. - UI-facing APIs return stable, normalized shapes. Do not leak raw Make response envelopes unless the route contract explicitly says so.
- Service route handlers validate query/body/path params before calling Make adapters and return 400 for invalid client input.
- Service adapters own Make request details such as
appKey,X-Make-Target, Make response code checks, pagination translation, file body mapping, and consuming a prepared login/session forwarding context. Auth/session mechanics and shared forwarding helpers belong tomake-app-auth; publish/runtime proxy header contracts belong tomake-app-runtime. - Make-backed record read APIs must call Make gateway Data API path
/make/data/v1/recordthrough the Service Make adapter. This applies to record list, record detail, lookup target-record reads, and any custom Service route that reads Make records. - Service Make adapters must forward the incoming request's established login context to Make gateway for Make-backed data reads and writes. At minimum, preserve the browser
Cookiesession header when the host uses cookie/unified-login auth, preserve an existingAuthorizationheader only when the host contract already uses bearer auth, and apply the host gateway context headers such asX-Forwarded-HostandX-Forwarded-Protothrough the shared auth/runtime helper. Do not invent auth policy here; usemake-app-authfor auth mechanics, but do not drop the login context before calling gateway. - Published/runtime Service APIs must never use
makeclias a data source. Do not shell out tomakecli,npx makecli, local makecli config, or makecli JSON stdout to serve schema, records, candidates, lookup options, files, or custom API data. Online Service containers do not have makecli, so runtime data must come from Make gateway/API adapters. - Make-backed Service config must read
appKeyfrom deployment-injectedMAKE_APP_KEY. Generated production code must not invent, hard-code, or acceptappKeyfrom UI requests. - If
MAKE_APP_KEYis missing for a Service that calls Make Meta/Data APIs, config loading must fail with a clear non-secret error before the Service is reported ready. Local test fixtures may injectMAKE_APP_KEYexplicitly. - New generated Service code reads Make adapter runtime config from
apps/service/src/config.tsor the host equivalent.MAKE_API_BASE_URLis the preferred gateway-origin env var;MAKE_SERVER_URLis a compatibility alias only. - If neither
MAKE_API_BASE_URLnorMAKE_SERVER_URLis configured for a Make-backed Service, config loading must fail with a clear non-secret error before the Service is reported ready. MAKE_API_BASE_URL/MAKE_SERVER_URLvalues are strict gateway origins such ashttp://make-gateway.make-dev. New generated Service code must not put/make,/api/make,/meta,/data,/auth, or another service path scope in this env var.- Make platform adapters own the service path scope, and the Make Meta/Data scope is fixed to
/make. Generated Service code derives Make upstream URLs by joining the gateway origin with/make/**, such ashttp://make-gateway.make-dev/make/meta/**andhttp://make-gateway.make-dev/make/data/**. - If the same Service calls other gateway services, those adapters define their own explicit service scopes from the same gateway origin. Do not strip
/makeout ofMAKE_API_BASE_URL, and do not overload a path-scoped base URL to reach unrelated services. - Service-to-gateway calls inside the cluster must not use the browser-facing
/api/makeprefix./api/make/**belongs to same-origin browser access and Service ingress; Service internal upstream URLs use gateway-origin plus service scope. - Service source must not hard-code concrete Make dev/test/prod domains, infer namespace-local gateway addresses, or map deployment environments to domains.
- Runtime Service code must not require
apps/dsl/**,/dsl/**, or copied*.yamlfiles to start or serve schema/data in published Apps. - Schema APIs normalize backend schema variants before UI sees them. Handle known variants such as
entity.properties.fields,entity.fields, or the host-documented equivalent at the Service/API boundary. - Record list and detail are separate contracts. Do not implement detail by calling list and guessing the first row when a single-record Make call exists.
- User and department candidates come from Service routes such as
GET /api/usersandGET /api/departmentsor the host equivalent; do not use local demo arrays in generated Service. - Lookup option APIs must resolve target object/field from schema metadata and return
{ options, total }. Do not expose full target records to selector UIs by default. - File routes proxy upload/delete/download through Service. UI should not expose raw backend file URLs when a Service download proxy is available.
- Browser resource tags such as
<img src>cannot attachAuthorization. When Make file downloads require a bearer token, keep the URL browser-facing through a Service download proxy, verify the current App session first, and let only the Service adapter attach the deployment-injected token. Do not put Make tokens or raw/data/v1/download/**URLs in UI state, public config, JSX, or logs. - Add boundary logs at route/adapter entry, success, and failure. Redact tokens, cookies, Authorization, API keys, signed download query strings, and unnecessary personal data.
- Tests are required for route contracts, invalid input, adapter payloads, Make error mapping, and any schema/value normalization added by this skill.
Default route baseline
Prefer these UI-Service contracts for new Make App Service projects unless the host project already documents equivalent routes:
GET /api/health
GET /health
GET /api/config
GET /api/schema
GET /api/entities/:entityKey/fields
GET /api/entities/:entityKey/records
GET /api/entities/:entityKey/records/:recordID
POST /api/entities/:entityKey/records
PATCH /api/entities/:entityKey/records/:recordID
DELETE /api/entities/:entityKey/records/:recordID
PATCH /api/entities/:entityKey/records/:recordID/cells/:fieldKey
GET /api/users
GET /api/departments
GET /api/lookup-options
POST /api/entities/:entityKey/records/:recordID/files/:fieldKey
DELETE /api/entities/:entityKey/records/:recordID/files/:fieldKey
GET /api/files/download/*
Lookup relation update routes are optional and should be generated only when the UI needs editable lookup relationships and the Service can preserve a full qfei_relation snapshot safely.
Collaboration rules
- With
makeui: this skill provides Service contracts and normalized API shapes;makeuidecides how UI renders them. - With
canvas-table-integration: this skill provides schema/records/candidate APIs; table rendering and editing UI stay in the canvas skill. - With
make-app-auth: this skill may preserve Service-fronted app route shape, but auth proxy and session behavior stay in auth. - With
make-app-runtime: this skill writes Service source and tests; runtime build/start/port checks stay in runtime.