API
A projekt hívható végpontja, belső a `call_project_api` segítségével, vagy külső az `api/mcp` végponton keresztül.
Az API program egy összehangoló réteg egyetlen kimenettel: adatforrást köthet, összehangolhatja a get_data, set_data és batch hívásokat a saját eseményein belül, és egyetlen választ ad vissza, amelyet sablon alakít, nem mezőkötések. Hívja a projekten belülről a call_project_api munkafolyamat-művelettel, vagy érje el kívülről a projekt api/mcp végpontján keresztül.
Tulajdonságok
progDataSource és progFields
Ugyanaz az alak, mint az Adatforrásé, akkor használják, ha az API a válasz összeállításának részeként táblát olvas vagy ír. A progFields a válaszsablonban elérhető mezőket deklarálja, table a valódi oszlopokhoz, virtual a számítottakhoz.
scriptData: a válaszsablon
A tartalom a scriptData.value helyen álló, sztringgé alakított objektumsablon; a @field kötések a hívás idején oldódnak fel, ugyanazzal a kifejezésszintaxissal, mint a platform bármely más részén:
API program hívása
Belsőleg a call_project_api pontosan úgy futtatja, ahogy a get_data vagy a set_data a saját programtípusait, a name.prog az API azonosítóját nevezi meg, a name.parameters a bemeneteit adja.
Kidolgozott példa
Deklarálja a felületet
progParams minden bemeneti (dir: "in") és kimeneti (dir: "out") értékhez.
Kössön adatot, ha a válasznak kell
Egy nem kötelező progDataSource, valamint progFields azokhoz az oszlopokhoz, amelyek a sablont táplálják.
Írja meg a válaszsablont
scriptData.value, egy sztringgé alakított objektum @field helyőrzőkkel, és állítsa be az apiOutput értékét arra a formátumra, amelyet a hívók visszakapjanak.
Hozzon létre egy API csomópontot a Programok alatt, állítsa be az apiOutput értékét a Tulajdonságok lapján, szükség esetén kössön Adatforrást, majd írja meg a válasz alakját a Válasz szerkesztőben.
A .xu <response> blokkja a scriptData.value, JSON-sztring helyett egyszerű objektumkifejezésként írva.