登录  /  注册

php接口文档怎么写

爱喝马黛茶的安东尼
发布: 2019-09-30 09:56:08
原创
4780人浏览过

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中文网其它相关文章!

智能AI问答
PHP中文网智能助手能迅速回答你的编程问题,提供实时的代码和解决方案,帮助你解决各种难题。不仅如此,它还能提供编程资源和学习指导,帮助你快速提升编程技能。无论你是初学者还是专业人士,AI智能助手都能成为你的可靠助手,助力你在编程领域取得更大的成就。
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
作者最新文章
最新问题
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习
PHP中文网抖音号
发现有趣的

Copyright 2014-2024 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号