api接口怎么写(API接口怎么写)

更新时间:2023-02-28 23:03:13 阅读: 评论:0

如何使用PHP的CodeIgniter框架来编写API接口

1.将解压的框架包放到的你的php环境的www/api目录下:这里建立api目录作为测试项目目录。并运行localhost/api/index.php,就可以看到环境界面了

2.在对应的目录下修改控制器中的方法:默认在application/controller/welcome.php文件中的

3.修改welcome.php中的index方法,看到的欢迎页面从这里加载的

4.开始写api接口吧,写api接口前要链接我们的数据库,配置数据库信息在application/config/databa.php中


5.连接配置好的数据库,回到我们的welcome.php中

6.去github官网中下载codeIgniter支持的api接口包

7.解压文件包,并将对应的文件放到指定的目录

8.修改控制器的方法名,把index该为index_get。

9.在浏览器中运行接口,根据不同的参数返回不同的数据。

获取的是json数据

localhost/api/index/php?urname=张三&format=json

获取的是xml数据

localhost/api/index/php?urname=张三&format=xml


php中的API接口怎么写 ?

以我目前的能力没法理解这个问题。但我举个例子,可能并不是你想要的答案,但没准可以提醒一下。我们用GOOGLE MAP API (开源)的时候,会引用一个类似接口的方法,方法有很多参数可以设置。比如这是个引用地图的方法,它的里面写了很多完整的方法,我这里就不放出来了,但是我举得例子是参数传递在最上面的initialize () (这里我们暂时当作接口)方法上,我们可以传递interface_zoom即缩放大小,interface_lati,interface_lngi就是经纬度等等参数,这些参数可以由我们自己处理,无论是从databa还是什么其他方法读取还是怎么运算,然后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
});
......
......

如何优雅的“编写”api接口文档

1. 拼写要准确
接口函数一旦发布就不能改了,要保持兼容性,拼写错误也不能改了,所以要仔细检查拼写,否则会被同行嘲笑很多年。
著名悲剧:unix 的 creat

2. 不仅是英文单词不要拼错,时态也不要错。
比如:
返回bool的判断函数,单数要用 is 复数要用are,这样你的命名就和文档中的描述保持了一致性。
表示状态的变量或者函数要注意时态,比如 onXxxxChanged 表示xxx已经变化了,isConnecting表示正在连接。
正确的时态可以给使用者传递更丰富的信息。

3. 函数最好是动宾结构
动宾结构就是 doSomething,这样的函数命名含义明确
比如: openFile, allocBuffer, tName
如果这个函数的动词宾语就是这个对象本身,那么可以省略掉宾语

4. 属性命名最好是定语+名词
比如 fileName, maxSize, textColor

5. 不要用生僻单词,这不是秀英语的地方,也不要用汉语拼音
比如:rendezvous,估计大多数人要去查词典才知道什么意思,这个词源自法语,是约会的意思。
Symbian OS里有个用它命名的函数,开发Symbian的是英国人,也许人家觉得很平常吧,反正我是查了词典才知道的。

6. 不要自己发明缩写
除非是约定俗成已经被广泛使用的缩写,否则老老实实用完整拼写。
坏例子: count->cnt, manager->mngr password->pw button->btn
现代的IDE都有很好的自动完成功能,名字长一点没关系的,可读性更重要。

7. 保持方法的对称性,有些方法一旦出现就应该是成对的,
比如 有open就要有clo,有alloc就要有free,有add就要有remove,这些单词基本是固定搭配的,使用者就很容易理解。
如果 open对应clear就有点让人困惑了。

API接口入门(一):读懂API接口文档

本文目录:

API接口是什么?

为什么我们需要API接口?

API接口的核心

一、API接口是什么?

我们来以一个常见的数学公式理解API,比如y=x+2,当x=2的时候,y=4,对么?

那此时,我们把y=x+2称为接口,x=2称为参数,y=4称为返回结果,那这个接口的功能就是能把我们输入的数加上2(注意:这里你可以发现接口自身是带有逻辑的)。

类比地,我们来理解一个常见的场景,比如现在有一个可以把经纬度转化为城市的接口,那当我输入经度是55°,纬度是88°的时候,接口通过自己的逻辑运算,返回结果告诉我:杭州市。

这样你就可以清晰地了解百度百科的官方解释了,接口就是预先定义的函数逻辑,他是供其他系统请求,然后返回结果的一个东西。

二、为什么我们需要API接口?

背景:我们的业务系统涉及多方多面,如果要一个公司或者一个系统把所有业务都做完,那未免工作量太大了吧?并且如果其他系统或公司有更好的运算逻辑,那我们在设计功能的时候可以考虑利用接口进行开发。

核心需求:利用现有接口可以降低开发成本,缩短开发成本。

举个例子:比如我是打车的APP,现在我需要在我的页面上展现地图的功能,对于我司而言,新做地图功能未免成本过高,那我们可以在高德开放平台或者百度地图的开放平台,找到地图API,这样的话我们只需要购买高德的服务,部署调用高德地图API,这样就可以快速在我们页面上线地图功能了。

三、API接口的核心

对于小白而言,初看API文档可能是一头雾水的——从哪里看,怎么看,看什么是摆在面前的问题。

其实对于产品经理而言,我们应该更关注这个公司可以提供什么样的API接口服务,比如我知道高德可以提供地图API,规划路线的API,这样的话在我们设计功能和工作中就可以想到调用他们的服务或者参考。

所以产品小白们看不懂也不用过于担心,未来工作中你也会更深入了解清楚,因为看懂并不复杂,以下是API接口的核心点,所有的说明文档离不开这5个核心点。

以下说明均以微信开放平台为例说明,文末有各开放平台的地址,大家有空可以去学习。好了,事不宜迟,现在我们来建立一个场景。

我们现在有一个APP,需要用户在购买的时候调起微信支付的API,完成购买。请各位自动进入这个场景,把自己当作一位产品经理。

1. 接口地址

现在Now,用户点击付款,我们需要告诉微信,我们要调起你们的收银台啦!但,去哪里告诉呢?这就需要接口地址了,也就相当于向微信的这条链接传输指定的数据。

一个链接地址不是我们理解的一个页面,你可以理解是一个电话号码,小白们要改变这个观念。

此时我们可以看到接口文档告诉我们链接是如下这条,那我们现在已经拨通微信的电话了。

2. 请求参数(报文)

我们现在需要告诉微信,你想调用收银台对吧。那我们需要写下来,此时生成的叫做报文,也就是你想告诉这个接口的内容是什么?相当于前文函数的输入x=2。

一般来说,报文的格式和内容都是按接口文档规定的。如下文就是微信开放平台对调起收银台的报文要求。

我们先来看前2个参数,你现在跟微信在对话,是不是应该先告诉微信,你是谁?这里微信的文档告诉你应该要用应用ID+商户号来确定你的身份,什么意思呢?

比如你是A商户,下面有a,b,c三个APP,所以微信要知道你是哪个商家,下面的哪个APP要用收银台。这是非常重要的,微信后面要把收到的钱打到对应的账户以及统计数据等。

那我们就在报文里面写下这两句话:

<appid>wx2421b1c4370ec43b</appid>(我的应用ID是wx2421…….)

<mch_id>10000100</mch_id>(我的商户号是10000…….)

好了,现在微信知道你是谁了,那你要告诉微信,你需要微信支付帮你收多少钱对吧?这里定义了货币类型和总金额,也就是收什么货币,收多少钱。

这里你看,货币类型的必填写了否,也就是说你也可以不告诉微信支付货币类型是什么,因为他在后面备注了默认是人民币。

好的,那我们写下两段报文

<free_type>CNY</ free_type >(我要收人民币)

<total_fee>1</total_fee>(我要收1元)

好了,现在微信知道你是谁,也知道要收多少钱了,那接下来微信支付要把收钱结果告诉你呀,因为你得知道用户是成功支付了才能继续发货,服务啊等等的。所以这里我们用到通知地址,就是告诉微信,等下完事了他去哪里告诉你支付结果。那我们把地址写好:

<notify_url>http://wxpay.wxutil.com/pub_v2/pay/notify.v2.php</notify_url>

3. 返回结果

刚刚微信支付已经去收款了,现在他要在我们留下的通知地址中,告诉我们结果了。结果无非是两种:成功收款?收款不成功?

(1)成功

很顺利,现在用户成功付钱了,并且微信也把成功的消息告诉我们了,并且他还把用户支付的一些信息也告诉我们。

那这里就是微信支付成功收款后告诉我们的信息。

应用APPID,商户号:告诉你我成功扣款的是哪家商户的哪个APPID的交易。

业务结果:成功或失败

(2)失败

在产品设计的时候,我们往往很关注失败的情况,当收款失败的时候,微信同时会告诉你失败的原因,如下图很好理解,失败的原因有很多很多种,我们在设计的时候往往要分析每种失败的原因,为每个失败的原因设计页面和用户提示,以确保用户能理解。

以上就是API接口基本运作模式的理解,下面我将继续更新API接口的一些更为深入和细节的关键元素,如请求方式/签名/加解密等等。

可供参考的开放平台网站

微信支付:https://pay.weixin.qq.com/wiki/doc/api/index.html

高德平台开放平台:https://lbs.amap.com/

本文发布于:2023-02-28 19:04:00,感谢您对本站的认可!

本文链接:https://www.wtabcd.cn/zhishi/a/167759659352609.html

版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系,我们将在24小时内删除。

本文word下载地址:api接口怎么写(API接口怎么写).doc

本文 PDF 下载地址:api接口怎么写(API接口怎么写).pdf

标签:接口   api   API
相关文章
留言与评论(共有 0 条评论)
   
验证码:
推荐文章
排行榜
Copyright ©2019-2022 Comsenz Inc.Powered by © 实用文体写作网旗下知识大全大全栏目是一个全百科类宝库! 优秀范文|法律文书|专利查询|