Saltar para o conteúdo
Verificado

API

Um endpoint chamável do projeto, interno através de call_project_api ou externo através do endpoint api/mcp.

Um programa de API é uma camada de orquestração com uma só saída: pode associar uma fonte de dados, coordenar chamadas get_data, set_data e batch dentro dos seus próprios eventos e devolver uma resposta, moldada por um modelo e não por associações de campos. Chame-o a partir de dentro do projeto com a ação de fluxo de trabalho call_project_api, ou alcance-o do exterior através do endpoint api/mcp do projeto.

Propriedades

progDataSource e progFields

A mesma forma que Fonte de dados, utilizada quando a API lê ou escreve numa tabela como parte da construção da sua resposta. progFields declara os campos disponíveis para o modelo de resposta, table para colunas reais, virtual para as calculadas.

scriptData: o modelo de resposta

A carga é um modelo de objeto em string em scriptData.value; as associações @field são resolvidas no momento da chamada, com a mesma sintaxe de expressões que em todo o lado na plataforma:

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

Chamar um programa de API

Internamente, call_project_api executa-o exatamente como get_data ou set_data executam os seus tipos de programa, name.prog indica o id da API, name.parameters fornece as suas entradas.

Exemplo prático

Declare a interface

progParams para cada valor de entrada (dir: "in") e de saída (dir: "out").

Associe dados se a resposta precisar deles

Uma progDataSource opcional, mais progFields para as colunas que alimentam o modelo.

Escreva o modelo de resposta

scriptData.value, um objeto em string com marcadores @field, e defina apiOutput para o formato que quem chama deve receber.

Crie um nó API em Programas, defina apiOutput no seu separador Propriedades, associe opcionalmente uma Fonte de dados e depois escreva a forma da resposta no editor Resposta.

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>

O bloco <response> do .xu é o scriptData.value, escrito como uma expressão de objeto simples em vez de uma string 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}" }
}