API文档如何写？
我也看不懂…
股票量化交易软件,接口的设计原则
在设计股票量化交易软件,接口时，有很多因素要考虑，如：
股票量化交易软件,接口的业务定位，股票量化交易软件,接口的安全性，股票量化交易软件,接口的可扩展性、股票量化交易软件,接口的稳定性、股票量化交易软件,接口的跨域性、股票量化交易软件,接口的协议规则、股票量化交易软件,接口的路径规则、股票量化交易软件,接口单一原则、股票量化交易软件,接口过滤和股票量化交易软件,接口组合等；
规范性建议
职责原则
在设计股票量化交易软件,接口时，必须明确股票量化交易软件,接口的职责，即股票量化交易软件,接口类型，股票量化交易软件,接口应解决什么业务问题等
单一性原则
在明确股票量化交易软件,接口职责的条件下，尽量做到股票量化交易软件,接口单即一个股票量化交易软件,接口只做一件事，而非两件以上。
协议规范
在设计股票量化交易软件,接口时，应明确股票量化交易软件,接口协议，是采用HTTP协议,HTTPS协议还是FTP协议，要根据具体情况来定。
FTP协议(FileTransferProtocol，简称FTP)，是一套标准的文件传输协议，用于传输文件，如.txt，.csv等，一般文件传输，采用FTP协议
HTTP协议，适用一般对安全性要求比较低或没要求的业务情景
HTTPS=HTTP+SSL,适用于对安全性要求较高的业务情景
路径规则
由于api获取的是一种资源，所以网址中尽量为名词，而非动词
/api/v0/Pruduct/2019
/api/v0/Users/2019
http请求方式
股票量化交易软件,接口基本访问协议：get(获取)，post(新增)，put(修改)和delete(删除)
get/users：列出所有用户
get/users/id：根据id获取用户(Q)
post/user：新增用户©
put/user/id：根据用户id更新用户(U)
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.返回数据格式
返回数据格式，一般包括三个字段：
失败情况(状态码、错误码和错误描述)
{
“status”:0,//状态码 0-表示失败，1-表示成功
“error_code”:”2003”,//错误码，一般在设计时定义
“error_des”:”身份验证失败”//错误描述，一般在设计时定义
}
成功情况(标识id,数据对象,状态码)
{
”sid“:”sh20190111”,//token id
”users“:{
”id“:”al201901111341”,//用户id
“name”:”Alan_beijing”,//用户名
“addr”:”用户地址”
},
“status”:1//状态码 0-表示失败，1-表示成功
}
安全性原则
股票量化交易软件,接口暴露的考虑，股票量化交易软件,接口并发量的考虑，股票量化交易软件,接口防攻击的考虑，股票量化交易软件,接口跨域的考虑等
可扩展性原则
在设计股票量化交易软件,接口时，充分考虑股票量化交易软件,接口的可扩展性。
定义api界限
定义api返回码
在api设计时，要定好api返回码，如
--授权过期
04–未找到资源
00–内部服务器错误
00–账号被锁
反规范性建议
存在这样一种业务场景：某个股票量化交易软件,接口需要返回多个api股票量化交易软件,接口组合的结果，在类似的业务场景下，所设计的股票量化交易软件,接口，具有一定的反规范性。
data:[
{url:'api1',type:'get',data:{...}},
{url:'api2',type:'get',data:{...}},
]
{
status:0,
msg:'',
data:[
{status:1,msg:'',data:[]},
{status:1,msg:'',data:{}}
]
}
实例
假设存在这样一个一个业务：一个ERP系统，需要提供两个股票量化交易软件,接口，一个是用户访问股票量化交易软件,接口(需要验证)，另一个是用户注册股票量化交易软件,接口(不需要验证)。
根据本篇文章二部分的建议，我们来设计满足该业务需求的股票量化交易软件,接口
定义统一参数
定义统一输入参数
定义统一输出参数
定义统一错误码
定义股票量化交易软件,接口授权类别
如下为定义股票量化交易软件,接口授权类别
用户股票量化交易软件,接口
用户注册
code示例
Request:
{
'mobile':13636595499,
'verify_code':'987654',
'pwd':'123456'
}
Responce:
(1)error
{
'status':0,
'error_code':1001，
'error_desc':'手机验证码已失效'
}
(2)succed
{
'sid':'sh201901141529',
'uid':1,
'status':1
}
用户登录
登录股票量化交易软件,接口概述
Responce:
1.error
{
'status':0,
'error_code':1002,
'error_desc':'密码错误'
}
2.succeed
{
'sid':'sh201901141529',
'user':{
'id':1,
'username':'',
age:0,
gender:0
},
'status':1
}
转载于2021/2/2日。
文章为作者独立观点，不代表 股票程序化软件自动交易接口观点
相关文章
股民评论