php介面文件怎麼寫

爱喝马黛茶的安东尼
發布: 2023-02-25 17:02:02
原創
5017 人瀏覽過

php介面文件怎麼寫

1、HTTP攜帶訊息的方式

#url

headers

body:包含請求體,響應體

2、分離通用資訊

一般來說,headers裡的資訊都是通用的,可以事先說明,作為預設參數

3、路徑中的參數表達式

URL中參數表達式使用mustache的形式,參數包裹在雙大括號之中{{paramName}}

相關推薦:《php入門教學

例如:

/api/user/{{userId}}
/api/user/{{userType}}?age={{age}}&gender={{gender}}
登入後複製

4、資料模型定義

資料模型定義包括:

·路徑與查詢字串參數模型

·請求體參數模型

##·響應體參數模型

資料模型的最小資料集:

名稱

#是否必須

說明

##################
“最小数据集”(MDS)是指通过收集最少的数据,较好地掌握一个研究对象所具有的特点或一件事情、一份工作所处的状态,
其核心是针对被观察的对象建立起一套精简实用的数据指标。最小数据集的概念起源于美国的医疗领域。最小数据集的产生源于信息
交换的需要,就好比上下级质量技术监督部门之间、企业与质量技术监督部门之间、质量技术监督部门与社会公众之间都存在着信息
交换的需求。
登入後複製
###有些文件裡可能會加入欄位的類型,但是我認為這是沒必要的。以為HTTP傳輸的資料往往都需要序列化,大部分資料型態都是字串。一些特殊的類型,例如枚舉類型的字串,可以在說明中描述。 ######另外:資料模型非常建議使用表格來表現。 ###

以上是php介面文件怎麼寫的詳細內容。更多資訊請關注PHP中文網其他相關文章!

相關標籤:
來源:php.cn
本網站聲明
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn
熱門教學
更多>
最新下載
更多>
網站特效
網站源碼
網站素材
前端模板