OpenAPI Édition Entreprise

Interface de connexion

Adresse de l’API	Méthode HTTP	Type de contenu
/user/login	POST	application/x-www-form-urlencoded

Nom du paramètre	Type	Obligatoire	Description
username	string	Oui	Nom d’utilisateur
password	string	Oui	Mot de passe

• L’accès à l’interface de connexion permet d’obtenir un jeton (token).
• Tous les accès aux API OpenAPI (à l’exception de l’interface de connexion) nécessitent une authentification.
• La méthode d’authentification consiste à inclure le champ Authorization dans l’en-tête de la requête, dont la valeur est le token.

Création d’une source de données

Adresse de l’API	Méthode HTTP	Type de contenu
/datasource/add	POST	application/json

• Exemple de paramètres :

{
  "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"
}

Suppression d’une source de données

Adresse de l’API	Méthode HTTP	Type de contenu
/datasource/delete/	POST	application/x-www-form-urlencoded

Création d’un groupe

Adresse de l’API	Méthode HTTP	Type de contenu
/group/create	POST	application/x-www-form-urlencoded

Nom du paramètre	Type	Obligatoire	Description
name	string	Oui	Nom du groupe

Suppression d’un groupe

Adresse de l’API	Méthode HTTP	Type de contenu
/group/delete/	POST	application/x-www-form-urlencoded

Création d’une API

Adresse de l’API	Méthode HTTP	Type de contenu
/apiConfig/add	POST	application/json

• Exemple de paramètres :

{
  "note": "Requête pour les données des étudiants",
  "cachePlugin": {
    "pluginType": 1
  },
  "access": 1,
  "paramsJson": [
    {
      "name": "id",
      "type": "bigint",
      "note": "ID de l’étudiant"
    }
  ],
  "taskJson": [
    {
      "taskType": 1,
      "sqlList": [
        {
          "sqlText": "select * from student where id = #{id}"
        }
      ],
      "transaction": 0,
      "datasourceId": "5iaIut1Z"
    }
  ],
  "paramRules": [
    {
      "apiId": "J3z0SP59",
      "script": "id > 0",
      "type": "JavaScript",
      "message": "L’ID doit être un nombre positif"
    }
  ],
  "groupId": "leqbGt5S",
  "globalTransformPlugin": {
    "pluginType": 3
  },
  "path": "student/all",
  "name": "Requête de données",
  "alarmPlugins": [
    {
      "pluginType": 2
    }
  ],
  "transformScript": {
    "type": "JavaScript"
  },
  "contentType": "application/x-www-form-urlencoded",
  "jsonParam": "{}"
}

Modification d’une API

Adresse de l’API	Méthode HTTP	Type de contenu
/apiConfig/update	POST	application/json

• Exemple de paramètres :

{
  "note": "Requête pour les données des étudiants",
  "cachePlugin": {
    "pluginType": 1,
    "apiId": "J3z0SP59"
  },
  "access": 1,
  "paramsJson": [
    {
      "note": "ID de l’étudiant",
      "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": "L’ID doit être un nombre positif"
    }
  ],
  "groupId": "leqbGt5S",
  "globalTransformPlugin": {
    "pluginType": 3,
    "apiId": "J3z0SP59"
  },
  "path": "student/all",
  "name": "Requête de données",
  "alarmPlugins": [
    {
      "pluginType": 2,
      "apiId": "J3z0SP59"
    }
  ],
  "transformScript": {
    "apiId": "J3z0SP59",
    "type": "JavaScript"
  },
  "id": "J3z0SP59",
  "contentType": "application/x-www-form-urlencoded"
}

Mise en ligne d’une API

Adresse de l’API	Méthode HTTP	Type de contenu
/apiConfig/online/	POST	application/x-www-form-urlencoded

Mise hors ligne d’une API

Adresse de l’API	Méthode HTTP	Type de contenu
/apiConfig/offline/	POST	application/x-www-form-urlencoded