Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Multimedia
nameDAGROFRAME-3830 - (Vídeo 2) TOTVS Agro Api Hub_PARTE_1_1.mp4
width800
height600

Cadastro de Entidade

A disponibilização das APIs no ta-api-hub é realizada via cadastro de entidades, definida e baseada na estrutura de dados da aplicação, conforme os cadastros a seguir:

...

http://127.0.0.1:8080/api/v1/entities 

Estrutura de dados:

Bloco de código
languagejava
titleEntity
{
	"id": "UUID",
	"name": "nomeEntidade",
	"description": "Descrição da Entidade",
	"product": "BIOENERGIA",
	"entityTable": "NOME_DA_TABELA",
	"lastUpdate": "2024-06-20T12:58:05.401",
	"entityDeList": [
		{
			"id": "UUID",
			"fieldName": "nomeDoCampo",
			"description": "Descricao do Campo",
			"tableColumn": "NOME_DA_COLUNA",
			"columnType": "STRING",
			"columnSize": 50,
			"columnRequired": true,
			"columnMask": null,
			"columnPk": true,
			"tableFk": null,
			"columnFk": null,
			"filter": true
		},
		...
	],
	"entityChildList": [
              {
                "id": "UUID",
                "entityChild":{}
                "entityChildType": ""
              },
              ...
	],
	"entityApi": {
		"id": "UUID",
		"pathUrl": "entidades",
		"apiVersion": "v1",
		"businessClass": "",
		"enableGet": true,
		"enablePost": true,
		"enablePut": true,
		"enableDelete": true,
		"enabled": true,
		"lastUpdate": "2024-06-20T12:58:05.401"
	}	
}

...


Header

  • id: Campo identificador único / chave do header (UUID)
  • name: Nome da entidade.
  • description: Descrição da entidade.
  • product: Produto associado à entidade (BIOENERGIA / MULTICULTIVO).
  • entityTable: Nome da tabela no banco de dados
  • lastUpdate: Data/hora da última atualização.

...

http://127.0.0.1:8080/api/v1/entities/summary 


Bloco de código
languagejava
titleResponse
[
    {
        "id": "a3427359-dc2f-4245-915c-972cfa2b25af",
        "name": "parametro",
        "description": "Parametros",
        "path": "api/entity/v1/parametros",
        "enableGet": true,
        "enablePost": false,
        "enablePut": false,
        "enableDelete": false,
        "enabled": true,
        "details": [
            {
                "id": "d4a0e418-9423-4516-940b-03d4de5b9800",
                "fieldName": "secao",
                "description": "Seção",
                "columnRequired": false,
                "columnPk": false,
                "filter": true
            },
            {
                "id": "6c076bf9-2456-4b46-b43a-1296047be0ab",
                "fieldName": "entrada",
                "description": "Entrada",
                "columnRequired": false,
                "columnPk": false,
                "filter": true
            },
            {
                "id": "87c60f83-7592-44d7-9005-43589a05dcda",
                "fieldName": "tipo",
                "description": "Tipo",
                "columnRequired": false,
                "columnPk": false,
                "filter": false
            },
            {
                "id": "2fe199e6-3209-463b-af31-1ef20794e2b5",
                "fieldName": "valor",
                "description": "Valor",
                "columnRequired": false,
                "columnPk": false,
                "filter": false
            },
            {
                "id": "0611d39b-42f8-4044-86db-bb9e6336c998",
                "fieldName": "descricao",
                "description": "Descrição",
                "columnRequired": false,
                "columnPk": false,
                "filter": true
            },
            {
                "id": "828fcde4-9d47-4270-b1a7-82f35f148517",
                "fieldName": "validos",
                "description": "Valores Válidos",
                "columnRequired": false,
                "columnPk": false,
                "filter": false
            },
            {
                "id": "a4802480-ed33-46b6-91c1-df0e442672ac",
                "fieldName": "instancia",
                "description": "Instancia",
                "columnRequired": false,
                "columnPk": false,
                "filter": true
            }
        ]
    },
    ...
]

Cadastro de Queries

A disponibilização das APIs no ta-api-hub também podes ser realizada via cadastro de queries, definida e baseada na estrutura de dados da aplicação, conforme os cadastros a seguir:

...

http://127.0.0.1:8080/api/v1/queries 

Estrutura de dados: 

Bloco de código
languagejava
titleQuery
[
    {
        "id": "UUID",
        "name": "nomeEstruturaDados",
        "description": "Descrição",
        "product": "BIOENERGIA",
        "pathUrl": "queries",
        "lastUpdate": "2024-06-20T04:58:05.401",
        "queryDeList": [
            {
                "id": "UUID",
                "apiVersion": "v1",
                "query": "SELECT CD_SAFRA, DE_SAFRA, DE_COMP_TBL FROM SAFRAS WHERE CD_SAFRA = ::codigo",
                "databaseType": "ORACLE",
                "httpMethod": "GET",
                "enabled": true
            },
            ...
        ],
        "queryFieldsList": [
            {
                "fieldName": "codigo",
                "tableColumn": "CD_SAFRA",
                "columnType": "INTEGER",
                "columnSize": 5,
                "columnRequired": true,
                "columnMask": null,
                "columnPk": true,
                "tableFk": null,
                "columnFk": null,
                "id": "697e73b0-9520-4819-a6dc-350172fd9792"
            },
            ...
        ]
    }
]

...

Query Header

  • id: Campo identificador único / chave do header (UUID)
  • name: Nome da estrutura de dados.
  • description: Descrição.
  • product: Produto associado à entidade (BIOENERGIA / MULTICULTIVO).
  • pathUrl: Path da url da entidade (Ex: instancias)
  • lastUpdate: Data/hora da última atualização.

...

http://127.0.0.1:8080/api/v1/queries/summary 


Bloco de código
languagejava
titleResponse
[
    {
        "id": "ce429b8e-e284-44c7-a37c-d7dfbb0b7aed",
        "name": "safra",
        "description": "Safras",
        "details": [
            {
                "id": "56c53717-727b-4b33-bfcd-57b6f85d20df",
                "query": "SELECT CD_SAFRA, DE_SAFRA, DE_COMP_TBL FROM SAFRAS WHERE CD_SAFRA = ::codigo",
                "httpMethod": "GET",
                "path": "/api/v1/safras",
                "enabled": true
            },
            {
                "id": "bf3bbf43-cb35-4cc7-8c50-4c441772d4ce",
                "query": "INSERT INTO SAFRAS(CD_SAFRA, DE_SAFRA, DE_COMP_TBL) VALUES (::codigo,::descricao,::complemento)",
                "httpMethod": "POST",
                "path": "/api/v1/safras",
                "enabled": true
            },
            {
                "id": "23856856-2b8b-48a4-988d-38a20dba7209",
                "query": "UPDATE SAFRAS SET DE_SAFRA = ::descricao, DE_COMP_TBL = ::complemento WHERE CD_SAFRA = ::codigo",
                "httpMethod": "PUT",
                "path": "/api/v1/safras",
                "enabled": true
            },
            {
                "id": "4ddbba69-91a3-4f6e-92c3-92cd24a8619a",
                "query": "DELETE FROM SAFRAS WHERE CD_SAFRA = ::codigo",
                "httpMethod": "DELETE",
                "path": "/api/v1/safras",
                "enabled": true
            }
        ]
    }
]

...



Consumo das APIs

Composição da URL da API

...

Multimedia
nameDAGROFRAME-3830 - (Vídeo 2) TOTVS Agro Api Hub_PARTE_2.mp4
width800
height600

---

🔗 Vídeo de demonstração/apresentação do "TOTVS Agro API Hub" (acesso TOTVS)


...


TOTVS Agro Middleware | Componente intermediário das APIs públicas do TOTVS Agro API Hub

...

Multimedia
namemiddlware-parte2.mp4
width800
height600

---

...


...


Framework e Engenharia TOTVS Agro

...