Przejdź do treści
Zweryfikowano

API

Wywoływalny punkt końcowy projektu, wewnętrzny przez call_project_api albo zewnętrzny przez punkt końcowy api/mcp.

Program API to warstwa orkiestracji z jednym wyjściem: może wiązać źródło danych, koordynować wywołania get_data, set_data i batch w swoich zdarzeniach i zwracać jedną odpowiedź, kształtowaną przez szablon, a nie przez powiązania pól. Wywołaj go z wnętrza projektu akcją przepływu pracy call_project_api albo dotrzyj do niego z zewnątrz przez punkt końcowy projektu api/mcp.

Właściwości

progDataSource i progFields

Ten sam kształt co w Źródle danych, używany, gdy API czyta tabelę lub zapisuje do niej w trakcie budowania odpowiedzi. progFields deklaruje pola dostępne dla szablonu odpowiedzi: table dla prawdziwych kolumn, virtual dla obliczanych.

scriptData: szablon odpowiedzi

Ładunek to szablon obiektu zapisany jako tekst w scriptData.value; powiązania @field są rozwiązywane w chwili wywołania, według tej samej składni wyrażeń co w całej platformie:

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

Wywoływanie programu API

Wewnętrznie call_project_api uruchamia go dokładnie tak, jak get_data lub set_data uruchamiają swoje typy programów: name.prog wskazuje identyfikator API, a name.parameters dostarcza jego wejścia.

Przykład krok po kroku

Zadeklaruj interfejs

progParams dla każdej wartości wejściowej (dir: "in") i wyjściowej (dir: "out").

Powiąż dane, jeśli odpowiedź ich potrzebuje

Opcjonalny progDataSource oraz progFields dla kolumn, które zasilają szablon.

Napisz szablon odpowiedzi

scriptData.value, obiekt zapisany jako tekst z symbolami zastępczymi @field, a apiOutput ustaw na format, jaki mają dostawać wywołujący.

Utwórz węzeł API w Programach, ustaw apiOutput na jego karcie Właściwości, opcjonalnie powiąż Źródło danych, a potem napisz kształt odpowiedzi w edytorze Odpowiedź.

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>

Blok <response> w .xu to scriptData.value, zapisany jako zwykłe wyrażenie obiektu, a nie tekst 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}" }
}