Hopp til innholdet
Bekreftet

API

Et kallbart endepunkt i prosjektet, internt gjennom call_project_api eller eksternt gjennom endepunktet api/mcp.

Et API-program er et orkestreringslag med én utgang: det kan binde en datakilde, koordinere get_data-, set_data- og batch-kall i sine egne hendelser, og gi tilbake ett svar, formet av en mal i stedet for av feltbindinger. Kall det fra innsiden av prosjektet med arbeidsflythandlingen call_project_api, eller nå det utenfra gjennom prosjektets api/mcp-endepunkt.

Egenskaper

progDataSource og progFields

Samme form som Datakilde, brukt når API-et leser eller skriver en tabell som del av å bygge svaret. progFields deklarerer feltene som er tilgjengelige for svarmalen, table for ekte kolonner, virtual for beregnede.

scriptData: svarmalen

Nyttelasten er en malt objekt som tekststreng på scriptData.value. @field-bindinger løses opp ved kallet, med den samme uttrykkssyntaksen som ellers på plattformen:

json
{ "value": "{\n   CS_Id: @CS_Id,\n   CS_Class_Id: @CS_Class_Id,\n   CS_School_Id: @CS_School_Id\n}" }

Å kalle et API-program

Internt kjører call_project_api det nøyaktig slik get_data eller set_data kjører sine programtyper. name.prog navngir API-ets id, name.parameters leverer inndataene.

Eksempel

Deklarer grensesnittet

progParams for hver inndataverdi (dir: "in") og utdataverdi (dir: "out").

Bind data hvis svaret trenger det

En valgfri progDataSource, pluss progFields for de kolonnene som mater malen.

Skriv svarmalen

scriptData.value, et objekt som tekststreng med @field-plassholdere, og sett apiOutput til formatet kallerne skal få tilbake.

Opprett en API-node under Programmer, sett apiOutput på fanen Egenskaper, bind eventuelt en Datakilde, og skriv så svarformen i Svar-editoren.

xml
<meta lang="json5">
{
  id: "student_classes_api",
  menuTitle: "Student Dashboard API",
  apiOutput: "json"
}
</meta>

<params lang="json5">
{
  in: { campus_in: "string", active_view_in: "string" }
}
</params>

<response>
({
  ok: true,
  campus: @campus_in,
  activeView: @active_view_in,
  summary: { students: 3, tasks: 3, profiles: 3 }
})
</response>

<response>-blokken i .xu er scriptData.value, skrevet som et vanlig objektuttrykk i stedet for en JSON-streng.

json
{
  "properties": {
    "menuType": "api", "menuName": "Student Classes", "apiOutput": "json",
    "progParams": [{ "id": 1734434656288, "data": { "dir": "in", "parameter": "user_id_in", "type": "string" }, "props": {} }]
  },
  "progDataSource": {
    "dataSourceType": "table", "dataSourceFilterModelType": "index",
    "dataSourceTableId": "5b1_tbl_…", "dataSourceIndexId": "be2d06c8-…"
  },
  "progFields": [
    { "id": 1489199308774, "data": { "type": "table", "field_id": "CS_Id" }, "props": { "fieldType": "string" } }
  ],
  "scriptData": { "value": "{\n   CS_Id: @CS_Id\n}" }
}