本文目录一览：
怎么写api接口
一些刚开始写接口文档的服务端同学，很容易按着代码的思路去编写接口文档，这让客户端同学或者是服务对接方技术人员经常吐槽，看不懂接口文档。这篇文章提供一个常规接口文档的编写方法，给大家参考。
推荐使用的是docway 写接口文档，方便保存和共享，支持导出PDF MARKDOWN，支持团队项目管理。
一、请求参数
1. 请求方法
GET
用于获取数据
POST
用于更新数据，可与PUT互换，语义上PUT支持幂等
PUT
用于新增数据，可与POST互换，语义上PUT支持幂等
DELETE
用于删除数据
其他
其他的请求方法在一般的接口中很少使用。如：PATCH HEAD OPTIONS
2. URL
url表示了接口的请求路径。路径中可以包含参数，称为地址参数，如**/user/{id}**，其中id作为一个参数。
3. HTTP Header
HTTP Header用于此次请求的基础信息，在接口文档中以K-V方式展示，其中Content-Type则是一个非常必要的header，它描述的请求体的数据类型。
常用的content-type：
application/x-www-form-urlencoded
请求参数使用“”符号连接。
application/json
内容为json格式
application/xml
内容为xml格式
multipart/form-data
内容为多个数据组成，有分隔符隔开
4. HTTP Body
描述http body，依赖于body中具体的数据类型。如果body中的数据是对象类型。则需要描述对象中字段的名称、类型、长度、不能为空、默认值、说明。以表格的方式来表达最好。
示例：
二、响应参数
1. 响应 HTTP Body
响应body同请求body一样，需要描述请清除数据的类型。
另外，如果服务会根据不同的http status code 返回不同的数据结构， 也需要针对不同的http status code对内容进行描述。
三、接口说明
说明接口的应用场景，特别的注意点，比如，接口是否幂等、处理是同步方式还是异步方式等。
四、示例
上个示例（重点都用红笔圈出来，记牢了）：
五、接口工具
推荐使用的是（以前叫小幺鸡） 写接口文档，方便保存和共享，支持导出PDF MARKDOWN，支持团队项目管理。
求助大神，php api接口怎么写
可以写个interface 让别人来实现接口的方法就行了。
任何网页都可以是接口，为了方便数据解析一般都用json和xml响应
php如何开发API接口
进入php源程序目录中的ext目录中，这里存放着各个扩展模块的源代码，选择你需要的模块，比如curl模块：cd curl
执行phpize生成编译文件，phpize在PHP安装目录的bin目录下
/usr/local/php5/bin/phpize
运行时，可能会报错：Cannot find autoconf. Please check your autoconf installation and
the $PHP_AUTOCONF
environment variable is set correctly and then rerun this
script.，需要安装autoconf：
yum install autoconf（RedHat或者CentOS）、apt-get install
autoconf（Ubuntu Linux）
/usr/local/php5/bin/php -v
执行这个命令时，php会去检查配置文件是否正确，如果有配置错误，
这里会报错，可以根据错误信息去排查！
PHP 的API接口
使用PHP写api接口是经常做的，PHP写好接口后，前台就可以通过链接获取接口提供的数据，而返回的数据一般分为两种情况，xml和json,在这个过程中，服务器并不知道，请求的来源是什么，有可能是别人非法调用我们的接口，获取数据，因此就要使用安全验证
原理
从图中可以看得很清楚，前台想要调用接口，需要使用几个参数生成签名。
时间戳：当前时间
随机数：随机生成的随机数
口令：前后台开发时，一个双方都知道的标识，相当于暗号
算法规则：商定好的运算规则，上面三个参数可以利用算法规则生成一个签名。前台生成一个签名，当需要访问接口的时候，把时间戳，随机数，签名通过URL传递到后台。后台拿到时间戳，随机数后，通过一样的算法规则计算出签名，然后和传递过来的签名进行对比，一样的话，返回数据。
算法规则
在前后台交互中，算法规则是非常重要的，前后台都要通过算法规则计算出签名，至于规则怎么制定，看你怎么高兴怎么来。
我这个算法规则是
时间戳，随机数，口令按照首字母大小写顺序排序
然后拼接成字符串
进行sha1加密
再进行MD5加密
转换成大写。
如何用PHP开发API接口
他会提供相应接口给你的，具体调用方法就相当于讲求某个链接。act=get_user_listtype=json在这里operate.php相当于一个接口，其中get_user_list 是一个API（获取用户列表），讲求返回的数据类型为JSON格式。
act=get_user_listtype=json’;$ch = curl_init ();curl_setopt ( $ch, CURLOPT_URL, $url );curl_setopt ( $ch, CURLOPT_RETURNTRANSFER, 1 );curl_setopt ( $ch, CURLOPT_CONNECTTIMEOUT, 10 );curl_setopt ( $ch, CURLOPT_POST, 1 ); //启用POST提交$file_contents = curl_exec ( $ch );curl_close ( $ch );
php中的API接口怎么写 ?
以我目前的能力没法理解这个问题。但我举个例子，可能并不是你想要的答案，但没准可以提醒一下。我们用GOOGLE MAP API （开源）的时候，会引用一个类似接口的方法，方法有很多参数可以设置。比如这是个引用地图的方法，它的里面写了很多完整的方法，我这里就不放出来了，但是我举得例子是参数传递在最上面的initialize () （这里我们暂时当作接口）方法上，我们可以传递interface_zoom即缩放大小，interface_lati，interface_lngi就是经纬度等等参数，这些参数可以由我们自己处理，无论是从database还是什么其他方法读取还是怎么运算，然后call这个initialize方法带指定参数就可以了，具体里面如何操作的地图，如何生成的地图，我们就不管了。接口就是我们看到日常生活中的插座，它规定好了规格，是几项的插头，我们就做成几项的插头，具体里面什么线路我们不管。方法中规定了什么类型的参数，我们就传什么类型的参数，具体里面有什么算法我们不管。个人最自白的解释，与官方有出入。
var map;
var infoWindow;
function initialize(interface_zoom,interface_lati,interface_lngi) {
var mapDiv = document.getElementById(‘map-canvas’);
map = new google.maps.Map(mapDiv, {
center: new google.maps.LatLng(interface_lati, interface_lngi),
zoom: interface_zoom,
mapTypeId: google.maps.MapTypeId.ROADMAP
});
……
……
｝
原创文章，作者：小蓝，如若转载，请注明出处：https://www.506064.com/n/151387.html
微信扫一扫 
支付宝扫一扫 