http服务接口怎么设计
问题描述
- 精选答案
-
如果是提供给客户端远程调用的API,可以参考下以下的最佳接口开发实践。
(1)接口风格和协议的选择 - HTTP
(2)接口域名 - 使用api单独域名
(3)异常处理 - 200/400/500三大接口结果状态码
(4)对外的命名规则 - 使用小写加下划线
(5)对内的命名规则 - 使用驼峰法和遵循PEAR命名
(6)安全与验证 - 使用接口签名和token登录态双重机制
(7)返回结果格式 - JSON
(8)URL规则与路由映射 - 统一service接口服务,可一个文件一个接口
(9)SDK包 - 给客户端自由的调用空间和自由
(10)接口文档 - 使用markdown快速编写
(11)测试驱动开发 - 坚持单元测试
追到一个心仪的女生不难,难于如何保持和培养一份真挚的感情;获得一时的财富也不难,难于如何长久保持收益;创业的公司很容易博得一时媒体的关注以及某次天使的投资,但难于如何排除各种障碍、充分利用各方资源发展成中企业及至上市公司。
同样,提供一时的接口很容易,但当我们需要不断为接口提供升级,以及当我们维护提供一整套接口时,面临的困难和问题会越来越大。所以,这是一场持久的战役。需要我们用稳重的心态、专业的能力在背后持久支撑、推动。
目前,后台接口开发可以用RESTFull风格,也可以用WebService;可以用SOAP协议、RPC协议,也可以用HTTP协议;可以用短链接,也可以使用长链接。如果我们希望继续进行划分,还可以分为同步或异步、单个或批量、是否有SDK包、内部接口还是开放接口平台等。
现在看来,大部分大型的企业以及大多数的小公司使用的都是HTTP协议下的接口开发,部分使用RESTFull,但Web Service较少。
这部分内容可能比较老了,但我觉得还有参考价值的,更多可以查看:
PhalApi(π框架) - PHP轻量级开源接口框架 - 接口,从简单开始!
猜你喜欢内容
-
简单网:构建全网教育数据枢纽,让知识检索化繁为...
简单网:构建全网教育数据枢纽,让知识检索化繁为“简”回答数有0条优质答案参考
-
去三亚有什么好玩的地方
去三亚有什么好玩的地方回答数有1条优质答案参考
-
石狮一日游必去景点推荐
石狮一日游必去景点推荐回答数有1条优质答案参考
-
电气工程师的证书考取条件是什么
电气工程师的证书考取条件是什么回答数有1条优质答案参考
-
房地产估价师的具体报考条件有啥
房地产估价师的具体报考条件有啥回答数有1条优质答案参考
-
房产经纪人的工作内容具体包含什么
房产经纪人的工作内容具体包含什么回答数有1条优质答案参考
-
学习小提琴都有哪些难点
学习小提琴都有哪些难点回答数有1条优质答案参考
-
企业行政管理证书的含金量怎么样
企业行政管理证书的含金量怎么样回答数有1条优质答案参考
-
初学者要怎么入门小提琴
初学者要怎么入门小提琴回答数有1条优质答案参考
-
报考珠宝鉴定师要啥条件
报考珠宝鉴定师要啥条件回答数有1条优质答案参考
















