OpenAPI Versão Empresarial

Interface de Login

Endereço da API	Método HTTP	Tipo de Conteúdo
/user/login	POST	application/x-www-form-urlencoded

Nome do Parâmetro	Tipo	Obrigatório	Descrição
username	string	Sim	Nome de usuário
password	string	Sim	Senha

• Acessar a interface de login permite obter um token.
• Todos os acessos às APIs OpenAPI (exceto a interface de login) exigem autenticação.
• O método de autenticação consiste em incluir o campo Authorization no cabeçalho da requisição, cujo valor é o token.

Criar Fonte de Dados

Endereço da API	Método HTTP	Tipo de Conteúdo
/datasource/add	POST	application/json

• Exemplo de parâmetros:

{
  "note": "local",
  "name": "local-mysql",
  "detail": {
    "type": "mysql",
    "url": "jdbc:mysql://localhost:3306/test?useSSL=false&characterEncoding=UTF-8&serverTimezone=GMT%2B8",
    "username": "root",
    "password": "root",
    "edit_password": true,
    "driver": "com.mysql.cj.jdbc.Driver",
    "druidProperties": "druid.testWhileIdle=true\ndruid.breakAfterAcquireFailure=true\ndruid.connectionErrorRetryAttempts=3",
    "tableSql": "show tables"
  },
  "type": "jdbc"
}

Excluir Fonte de Dados

Endereço da API	Método HTTP	Tipo de Conteúdo
/datasource/delete/	POST	application/x-www-form-urlencoded

Criar Grupo

Endereço da API	Método HTTP	Tipo de Conteúdo
/group/create	POST	application/x-www-form-urlencoded

Nome do Parâmetro	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do grupo

Excluir Grupo

Endereço da API	Método HTTP	Tipo de Conteúdo
/group/delete/	POST	application/x-www-form-urlencoded

Criar API

Endereço da API	Método HTTP	Tipo de Conteúdo
/apiConfig/add	POST	application/json

• Exemplo de parâmetros:

{
  "note": "Consultar dados de alunos",
  "cachePlugin": {
    "pluginType": 1
  },
  "access": 1,
  "paramsJson": [
    {
      "name": "id",
      "type": "bigint",
      "note": "ID do aluno"
    }
  ],
  "taskJson": [
    {
      "taskType": 1,
      "sqlList": [
        {
          "sqlText": "select * from student where id = #{id}"
        }
      ],
      "transaction": 0,
      "datasourceId": "5iaIut1Z"
    }
  ],
  "paramRules": [
    {
      "apiId": "J3z0SP59",
      "script": "id > 0",
      "type": "JavaScript",
      "message": "O ID deve ser um número positivo"
    }
  ],
  "groupId": "leqbGt5S",
  "globalTransformPlugin": {
    "pluginType": 3
  },
  "path": "student/all",
  "name": "Consulta de Dados",
  "alarmPlugins": [
    {
      "pluginType": 2
    }
  ],
  "transformScript": {
    "type": "JavaScript"
  },
  "contentType": "application/x-www-form-urlencoded",
  "jsonParam": "{}"
}

Atualizar API

Endereço da API	Método HTTP	Tipo de Conteúdo
/apiConfig/update	POST	application/json

• Exemplo de parâmetros:

{
  "note": "Consultar dados de alunos",
  "cachePlugin": {
    "pluginType": 1,
    "apiId": "J3z0SP59"
  },
  "access": 1,
  "paramsJson": [
    {
      "note": "ID do aluno",
      "name": "id",
      "type": "bigint"
    }
  ],
  "taskJson": [
    {
      "taskType": 1,
      "sqlList": [
        {
          "sqlText": "select * from student where id = #{id}"
        }
      ],
      "transaction": 0,
      "datasourceId": "5iaIut1Z"
    }
  ],
  "paramRules": [
    {
      "id": 1,
      "apiId": "J3z0SP59",
      "script": "id > 0",
      "type": "JavaScript",
      "message": "O ID deve ser um número positivo"
    }
  ],
  "groupId": "leqbGt5S",
  "globalTransformPlugin": {
    "pluginType": 3,
    "apiId": "J3z0SP59"
  },
  "path": "student/all",
  "name": "Consulta de Dados",
  "alarmPlugins": [
    {
      "pluginType": 2,
      "apiId": "J3z0SP59"
    }
  ],
  "transformScript": {
    "apiId": "J3z0SP59",
    "type": "JavaScript"
  },
  "id": "J3z0SP59",
  "contentType": "application/x-www-form-urlencoded"
}

Publicar API

Endereço da API	Método HTTP	Tipo de Conteúdo
/apiConfig/online/	POST	application/x-www-form-urlencoded

Despublicar API

Endereço da API	Método HTTP	Tipo de Conteúdo
/apiConfig/offline/	POST	application/x-www-form-urlencoded