http://www.udegmi.com

                                                                  【五分快3】php接口文档怎么写-PHP问题

                                                                  1、HTTP携带信息的方式

                                                                  url

                                                                  headers

                                                                  body:包括请求体,响应体

                                                                  2、分离通用信息

                                                                  一般来说,headers里的信息都是通用的,可以提前说明,作为默认参数

                                                                  3、路径中的参数表达式

                                                                  URL中,参数表达式使用mustache的形式,参数包裹在双大括号之中{{pa)ramName}}

                                                                  相关推荐:《php入门教程》

                                                                  例如:

                                                                  /api/user/{{userId}}/api/user/{{userType}}?age={{age}}&gender={{gender}}

                                                                  4、数据模型定义

                                                                  数据模型定义包括:

                                                                  ·路径与查询字符串参数模型

                                                                  ·请求体参数模型

                                                                  ·响应体参数模型

                                                                  数据模型的最小数据集:

                                                                  名称

                                                                  是否必须

                                                                  说明

                                                                  “最小数据集”(MDS)是指通过收集最少的数据,较好地掌握一个研究对象所具有的特点或一件事情、一份工作所处的状态,其核心是针对被观察的对象建立起一套精简实用的数据指标。最小数据集的概念起源于美国的医疗领域。最小数据集的产生源于信]息交换的需要,就好比上下级质量技术监督部(门之间、企业与质量技术监督部门之间、质量技术监督部门与社会公众之间都存在着信息交换的[需求。

                                                                  一些文档里可能会加入字段的类型,但是我认为这是没必要的。以为HTTP传输的数据往往都需要序列化,大部分数据类型都是字符串。一些特殊的类型,例如枚举类型的字符串,可以在说明里描述。

                                                                  另外:数据模型非常建议使用表格来表现。

                                                                  以上就是php接口文档怎么写的详细内容,更多请关注php中文网其它相关文章!

                                                                1. 微信
                                                                2. 分享php中文网最新课程二维码相关标签:php 接口文档
                                                                3. 本文原创发布php中文网
                                                                4. 郑重声明:本文版权归原作者所有,转载文章仅为传播更多信息之目的,如作者信息标记有误,请第一时间联系我们修改或删除,多谢。

                                                                  上一篇:2019国际人工智能及智慧物流大会今开幕 共话AI赋能产业
                                                                  下一篇:没有了