軟件接口(API)

一、分類 

1、REST API（restful風格的API）

①     發送請求進行CRUD哪個操作由請求方式來決定

②     同一個請求路徑可以進行多個操作

③     請求方式會用到GET/POST/PUT/DELETE

2、非REST API（restless風格的API）

①     請求方式不決定請求的CRUD操作

②     一個請求路徑只對應一個操作

③     一般只有GET/POST

CRUD：是指在做計算處理時的增加(Create)、檢索(Retrieve)、更新(Update)和刪除(Delete)幾個單詞的首字母簡寫。crud主要被用在描述軟件系統中數據庫或者持久層的基本操作功能。

 

二、組成部分

一個合格的接口文檔應該包括以下六項內容：

（一）接口名稱：用來標識各個接口的簡單說明，例如登錄接口，獲取圖書列表接口等；

（二）接口URL：接口的調用地址；

（三）調用方式：接口的調用方式，例如GET或POST；

（四）參數格式：接口需要傳遞的參數，每個參數需包含參數名稱、參數類型、是否必選、參數說明這4項內容；

（五）相應格式：接口的返回值的詳細描述，一般包含數據名稱、數據類型、說明這3項內容；

（六）返回實例：（此為可選項）通過對象的形式，例舉服務器返回數據的結構。

 

三、接口文檔示例

文檔信息
版本信息

版本號	創建時間	作者	受控狀態	審核	校對
0.1	2021.05.26	李飛	受控

 

 

 

修改信息

 

序號	修改后版本號	修改日期	修改人	修改原因	修改內容
1	0.5	2021.05.26	李飛	填充數據	用戶-新增接口

 

 

 

***********************************************************************************

接口信息
用戶設置（接口名稱）

新增

請求地址：http://www.baidu.com
請求方法：POST
請求參數示例：

id=6&nameLike=張三

請求頭：

Content-Type: application/json;charset=UTF-8

請求參數說明：

參數名稱	參數類型	是否必填（必選）	默認值	參數說明
id	Number	否		圖書ID
bookname	String	否		圖書名稱
author	String	否		圖書作者
publisher	String	否		出版社

 

 

 

 

 

 

 

請求體示例：

 {
    "rearNo": "",
    "feeName": "后勤報銷測試",
    "feeCode": "2",
    "unit": "2",
    "amount": "6",
    "price": "10",
    "totalPrice": "60",
    "rearBy": "莫",
    "orgId": "depart2",
    "convoyId": "CD-SCCD",
    "rearDate": "2018-05-04 00:00:00",
    "remark": ""
  }

 

返回結果參數說明：

數據名稱	數據類型	說明
status	Number	200成功；500失敗；
msg	String	對status字段的詳細說明
data	Array	圖書列表
*id	Number	圖書ID
*bookname	String	圖書名稱
*author	String	圖書作者
*publisher	String	出版社

 

 

 

 

 

 

 

 

 

 

返回結果示例：