Sari la conținut
Verificat

API

Un endpoint apelabil al proiectului, intern prin call_project_api sau extern prin endpointul api/mcp.

Un program API este un strat de orchestrare cu o singură ieșire: poate lega o sursă de date, poate coordona apeluri get_data, set_data și batch în propriile evenimente și returnează un singur răspuns, modelat de un șablon, nu de legări de câmpuri. Îl apelezi din interiorul proiectului cu acțiunea de workflow call_project_api sau îl accesezi din exterior prin endpointul api/mcp al proiectului.

Proprietăți

progDataSource și progFields

Aceeași structură ca Sursă de date, folosită când API-ul citește sau scrie un tabel ca parte din construirea răspunsului. progFields declară câmpurile disponibile pentru șablonul de răspuns, table pentru coloane reale, virtual pentru cele calculate.

scriptData: șablonul de răspuns

Conținutul este un șablon de obiect sub formă de șir în scriptData.value; legările @field se rezolvă în momentul apelului, cu aceeași sintaxă de expresii ca în restul platformei:

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

Apelarea unui program API

Intern, call_project_api îl rulează exact cum get_data sau set_data își rulează tipurile de program: name.prog numește id-ul API-ului, name.parameters furnizează intrările lui.

Exemplu lucrat

Declară interfața

progParams pentru fiecare valoare de intrare (dir: "in") și de ieșire (dir: "out").

Leagă date dacă răspunsul are nevoie de ele

Un progDataSource opțional, plus progFields pentru coloanele care alimentează șablonul.

Scrie șablonul de răspuns

scriptData.value, un obiect sub formă de șir cu substituenți @field, și setează apiOutput la formatul pe care trebuie să-l primească apelanții.

Creează un nod API sub Programe, setează apiOutput în fila Proprietăți, leagă opțional o Sursă de date, apoi scrie forma răspunsului în editorul Răspuns.

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>

Blocul <response> din .xu este scriptData.value, scris ca o expresie de obiect simplă, nu ca un șir JSON.

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}" }
}