API如何優雅的獲取單條數據

案例一

• 對于查詢類API，查詢的是單條數據，比如根據主鍵ID查詢用戶信息，sql如下：

select id, name, age from user where id = #{id}

• API默認返回的數據格式是多條的，如下：

{"success": true,"data": [{"id": 1,"name": "John","age": 18"}],"msg": null
}

• 但實際上我們希望返回的數據格式是單條的，如下這樣：

{"success": true,"data": {"id": 1,"name": "John","age": 18"},"msg": null
}

案例二

• 如果API是查詢單條數據的單個字段，比如根據主鍵ID查詢用戶名，sql如下：

select name from user where id = #{id}

• 默認返回的數據格式如下：

{"success": true,"data": [{"name": "John"}],"msg": null
}

• 但實際上我們希望返回的數據格式是單個字符串，如下這樣：

{"success": true,"data": "John","msg": null
}

解決方案

• 上面2個案例都可以用數據轉換插件來實現，官方插件市場已經提供了單條數據取值插件，直接使用它即可實現

• 下載插件，放到安裝目錄下的extlib目錄下，并重啟DBAPI
• 修改API配置，執行器 - SQL - 插件名稱選擇此插件即可

• 注意插件參數不填，就返回單條對象數據，對應實現案例一

• 如果要實現案例二，就要填寫插件參數，參數填寫要提取的字段名，比如填寫name

插件文檔

• 具體實現請查看插件文檔