OpenAPI versión empresarial

Interfaz de inicio de sesión

Dirección de la API	Método de solicitud	Tipo de contenido
/user/login	POST	application/x-www-form-urlencoded

Nombre del parámetro	Tipo	Obligatorio	Descripción
username	string	Sí	Nombre de usuario
password	string	Sí	Contraseña

• Al acceder a la interfaz de inicio de sesión se obtiene un token.
• Todos los accesos a las APIs (excepto la interfaz de inicio de sesión) requieren autenticación.
• El método de autenticación consiste en incluir el campo Authorization en la cabecera de la solicitud, cuyo valor es el token.

Crear una fuente de datos

Dirección de la API	Método de solicitud	Tipo de contenido
/datasource/add	POST	application/json

• Ejemplo 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"
}

Eliminar una fuente de datos

Dirección de la API	Método de solicitud	Tipo de contenido
/datasource/delete/	POST	application/x-www-form-urlencoded

Crear un grupo

Dirección de la API	Método de solicitud	Tipo de contenido
/group/create	POST	application/x-www-form-urlencoded

Nombre del parámetro	Tipo	Obligatorio	Descripción
name	string	Sí	Nombre del grupo

Eliminar un grupo

Dirección de la API	Método de solicitud	Tipo de contenido
/group/delete/	POST	application/x-www-form-urlencoded

Crear una API

Dirección de la API	Método de solicitud	Tipo de contenido
/apiConfig/add	POST	application/json

• Ejemplo de parámetros:

{
  "note": "Consultar datos de estudiantes",
  "cachePlugin": {
    "pluginType": 1
  },
  "access": 1,
  "paramsJson": [
    {
      "name": "id",
      "type": "bigint",
      "note": "ID del estudiante"
    }
  ],
  "taskJson": [
    {
      "taskType": 1,
      "sqlList": [
        {
          "sqlText": "select * from student where id = #{id}"
        }
      ],
      "transaction": 0,
      "datasourceId": "5iaIut1Z"
    }
  ],
  "paramRules": [
    {
      "apiId": "J3z0SP59",
      "script": "id > 0",
      "type": "JavaScript",
      "message": "El ID debe ser positivo"
    }
  ],
  "groupId": "leqbGt5S",
  "globalTransformPlugin": {
    "pluginType": 3
  },
  "path": "student/all",
  "name": "Consulta de datos",
  "alarmPlugins": [
    {
      "pluginType": 2
    }
  ],
  "transformScript": {
    "type": "JavaScript"
  },
  "contentType": "application/x-www-form-urlencoded",
  "jsonParam": "{}"
}

Modificar una API

Dirección de la API	Método de solicitud	Tipo de contenido
/apiConfig/update	POST	application/json

• Ejemplo de parámetros:

{
  "note": "Consultar datos de estudiantes",
  "cachePlugin": {
    "pluginType": 1,
    "apiId": "J3z0SP59"
  },
  "access": 1,
  "paramsJson": [
    {
      "note": "ID del estudiante",
      "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": "El ID debe ser positivo"
    }
  ],
  "groupId": "leqbGt5S",
  "globalTransformPlugin": {
    "pluginType": 3,
    "apiId": "J3z0SP59"
  },
  "path": "student/all",
  "name": "Consulta de datos",
  "alarmPlugins": [
    {
      "pluginType": 2,
      "apiId": "J3z0SP59"
    }
  ],
  "transformScript": {
    "apiId": "J3z0SP59",
    "type": "JavaScript"
  },
  "id": "J3z0SP59",
  "contentType": "application/x-www-form-urlencoded"
}

Publicar una API

Dirección de la API	Método de solicitud	Tipo de contenido
/apiConfig/online/	POST	application/x-www-form-urlencoded

Retirar una API

Dirección de la API	Método de solicitud	Tipo de contenido
/apiConfig/offline/	POST	application/x-www-form-urlencoded