在设计股票交易编程接口,接口时,有很多因素要考虑,如股票交易编程接口,接口的业务定位,股票交易编程接口,接口的安全性,股票交易编程接口,接口的可扩展性、股票交易编程接口,接口的稳定性、股票交易编程接口,接口的跨域性、股票交易编程接口,接口的协议规则、股票交易编程接口,接口的路径规则、股票交易编程接口,接口单一原则、股票交易编程接口,接口过滤和股票交易编程接口,接口组合等诸多因素,本篇文章将简要分析这些因素。
规范性建议
职责原则
在设计股票交易编程接口,接口时,必须明确股票交易编程接口,接口的职责,即股票交易编程接口,接口类型,股票交易编程接口,接口应解决什么业务问题等。
单一性原则
在明确股票交易编程接口,接口职责的条件下,尽量做到股票交易编程接口,接口单即一个股票交易编程接口,接口只做一件事,而非两件以上。很多非资深股票交易编程接口,接口设计者,在设计股票交易编程接口,接口时,总认为股票交易编程接口,接口所做的事越多,越牛叉,这是非常严重的错误认识。
协议规范
在设计股票交易编程接口,接口时,应明确股票交易编程接口,接口协议,是采用HTTP协议,HTTPS协议还是FTP协议,要根据具体情况来定。
FTP协议(FileTransferProtocol,简称FTP),是一套标准的文件传输协议,用于传输文件,如.txt,.csv等,一般文件传输,采用FTP协议。
HTTP协议,适用一般对安全性要求比较低或没要求的业务情景。
HTTPS=HTTP+SSL,适用于对安全性要求较高的业务情景。
路径规则
由于api获取的是一种资源,所以网址中尽量为名词,而非动词
http请求方式
股票交易编程接口,接口基本访问协议:get(获取),post(新增),put(修改)和delete(删除)
get/users:列出所有用户
get/users/id:根据id获取用户
post/user:新增用户
put/user/id:根据用户id更新用户
delete/user/id:根据用户id删除用户
域名
一般地,域名分为主域名和专有域名,主域名适合api长期不变或变化较少的业务,专有域名是解决具体的专有业务的
以百度举例:
主域名:www.baidu.com
产品服务类
市场活动类
跨域考虑
在明确域名的情况下,一定要考虑股票交易编程接口,接口是否跨域,以及跨域应采用的技术手段等
api版本
对于股票交易编程接口,接口的url,应加版本号http://apdemo.com/v{d}/,如,其中d表示版本号,如v0,v0
例子:获取产品号为2019,版本号为v0的版本号的产品信息
适度过滤信息
当记录数比较多时(如SELECT*FROMTBNam,因适当添加一些条件对数据进行过滤,如TOP,分页,分组,排序和WHERE条件等
下面是一些常见的参数。
?limit=100:返回100条数据
?offset=10从第101条数据开始返回
?page=10:指第10页
per_page=100:每页100条数据
?sortby=name:排序字段
?order=desc:降序
?group=groupName:分组
?producy_type=筛选条件
0、返回数据格式
返回数据格式,一般包括三个字段:
失败情况
成功情况
安全性原则
股票交易编程接口,接口暴露的考虑,股票交易编程接口,接口并发量的考虑,股票交易编程接口,接口防攻击的考虑,股票交易编程接口,接口跨域的考虑等。
可扩展性原则
在设计股票交易编程接口,接口时,充分考虑股票交易编程接口,接口的可扩展性。
定义api界限
定义api返回码
在api设计时,要定好api返回码,如:
--授权过期
04--未找到资源
00--内部服务器错误
00--账号被锁
反规范性建议
存在这样一种业务场景:某个股票交易编程接口,接口需要返回多个api股票交易编程接口,接口组合的结果,在类似的业务场景下,所设计的股票交易编程接口,接口,具有一定的反规范性。
实例
假设存在这样一个一个业务:一个ERP系统,需要提供两个股票交易编程接口,接口,一个是用户访问股票交易编程接口,接口(需要验证),另一个是用户注册股票交易编程接口,接口(不需要验证)。
根据本篇文章二部分的建议,我们来设计满足该业务需求的股票交易编程接口,接口
定义统一参数
定义统一输入参数
定义统一输出参数
定义统一错误码
定义股票交易编程接口,接口授权类别
如下为定义股票交易编程接口,接口授权类别
用户股票交易编程接口,接口
用户注册
code示例
用户登录
文章为作者独立观点,不代表 股票程序化软件自动交易接口观点