HTTP API響應資料規範整理

2021-07-09 20:57:18 字數 1887 閱讀 8775

文件目的為規範伺服器端api介面,便於伺服器端與客戶端**重用。伺服器端和客戶端可根據實際所定義規範編寫序列化和反序列化工具,以便減少一些開發時間。

用於client向server發起的post、put和delete請求

json

參考

xml格式

參考

<?xml version="1.0" encoding="utf-8"?> 

result>

單項資料查詢

json

參考

}

示例

}

xml格式

參考

<?xml version="1.0" encoding="utf-8"?>

code>

id>

name>

age>

<***>

***>

datum>

result>

示例
<?xml version="1.0" encoding="utf-8"?>

1code>

3id>

jennifername>

23age>

<***>female***>

datum>

result>

列表資料查詢

json格式

參考

,]

}

示例
,]

}

xml格式

參考

<?xml version="1.0" encoding="utf-8"?> 

result>

示例
<?xml version="1.0" encoding="utf-8"?>

1code>

5id>

lenboname>

21age>

<***>male***>

datum>

data>

result>

分頁資料查詢

json格式

參考

,

"data": [,,]

}

示例
,

"data": [,]

}

xml格式

參考

<?xml version="1.0" encoding="utf-8"?>

code>

totalpage>

count>

curr>

totalcount>

page>

datum>

datum>

data>

result>

示例
<?xml version="1.0" encoding="utf-8"?>

1code>

20totalpage>

10count>

2curr>

180totalcount>

page>

5id>

lenboname>

21age>

<***>male***>

datum>

2id>

jennifername>

23age>

<***>female***>

datum>

data>

result>

僅供參考,api介面開發人員可根據實際情況自定義相應結果碼或節點

#規範

HTTP API 設計指南(響應部分)

這篇指南介紹描述了 http json api 的一種設計模式,最初摘錄整理自 heroku 平台的 api 設計指引 heroku 平台 api 指引。這篇指南除了詳細介紹現有的 api 外,heroku 將來新加入的內部 api 也會符合這種設計模式,我們希望非 heroku 員工的api設計者...

InfluxDB之HTTP API查詢資料

http api是查詢influxdb資料的主要方式 查詢資料庫的其他方法請參閱命令列介面和客戶端庫 curl g http localhost 8086 query?pretty true data urlencode db mydb data urlencode q select value f...

PSR規範0 4整理

psr規範 引言 psr 是 php standard recommendations 的簡寫,由 php fig 組織制定的 php 規範,是 php 開發的實踐標準。這些規範的目的是 通過框架作者或者框架的代表之間討論,以最低程度的限制,制定乙個協作標準,各個框架遵循統一的編碼規範,避免各家自行...