Aller au contenu
Vérifié

API

Un endpoint appelable du projet, interne via call_project_api ou externe via l'endpoint api/mcp.

Un programme API est une couche d'orchestration avec une seule sortie : il peut lier une source de données, coordonner des appels get_data, set_data et batch dans ses propres événements, et renvoyer une seule réponse, façonnée par un modèle plutôt que par des liaisons de champs. Appelez-le depuis le projet avec l'action de workflow call_project_api, ou atteignez-le de l'extérieur via l'endpoint api/mcp du projet.

Propriétés

progDataSource et progFields

Même forme que Source de données, utilisée quand l'API lit ou écrit une table pour construire sa réponse. progFields déclare les champs disponibles pour le modèle de réponse, table pour de vraies colonnes, virtual pour des colonnes calculées.

scriptData : le modèle de réponse

La charge utile est un modèle d'objet sous forme de chaîne dans scriptData.value ; les liaisons @field sont résolues à l'appel, avec la même syntaxe d'expression que partout ailleurs dans la plateforme :

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

Appeler un programme API

En interne, call_project_api l'exécute exactement comme get_data ou set_data exécutent leurs types de programme : name.prog nomme l'identifiant de l'API, name.parameters fournit ses entrées.

Exemple concret

Déclarez l'interface

progParams pour chaque valeur d'entrée (dir: "in") et de sortie (dir: "out").

Liez des données si la réponse en a besoin

Un progDataSource facultatif, plus progFields pour les colonnes qui alimentent le modèle.

Écrivez le modèle de réponse

scriptData.value, un objet sous forme de chaîne avec des espaces réservés @field, et réglez apiOutput sur le format que les appelants doivent recevoir.

Créez un nœud API sous Programmes, définissez apiOutput dans son onglet Propriétés, liez éventuellement une Source de données, puis écrivez la forme de la réponse dans l'éditeur Réponse.

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>

Le bloc <response> de .xu est scriptData.value, écrit comme une expression d'objet simple plutôt que comme une chaîne 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}" }
}