美文网首页
RestAPI设计标准?

RestAPI设计标准?

作者: 方健 | 来源:发表于2017-01-04 11:16 被阅读23次

要设计些Restful API,试图看看业界对错误返回有没有标准。看了几个:
https://developers.douban.com/wiki/?title=api_v2
https://github.com/FanfouAPI/FanFouAPIDoc/wiki
https://developer.github.com/v3/
http://open.weibo.com/wiki/API%E6%96%87%E6%A1%A3_V2
https://dev.twitter.com/rest/public/search

douban

{
 "msg":"uri_not_found", 
 "code":1001, 
 "request":"GET \/v2\/photo\/132"
}

fanfou

{
 "request":"/account/show.json", 
 "error":"参数错误"
}

twitter

{"error":"Sorry, your query is too complex. Please reduce complexity and try again."}

github

{ 
 "message": "Bad credentials", 
 "documentation_url": "https://developer.github.com/v3"
}

weibo

{   
 "request" : "/statuses/home_timeline.json",    
 "error_code" : "20502",    
 "error" : "Need you follow uid."
}

结论:没有统一标准。大家随便玩儿吧。

大多数使用了error表示错误信息,有的用error_code表示错误编号。error_code这个东西,某些程度上可以帮助多语言化。但是也会使得api很累赘,而且……编号也很麻烦,编了号还得查表。直接用英文的error信息是比较方便的。多语言时就翻译一下。
这样说来。我选择twitter的表达方式。

相关文章

  • RestAPI设计标准?

    要设计些Restful API,试图看看业界对错误返回有没有标准。看了几个:https://developers....

  • 2020设计技能-《家具设计尺寸标准》

    【格式】PDF 【目录】 1.趟门衣柜设计标准 2.平开门衣柜设计标准 3.功能件设计标准 4.书柜类设计标准

  • openfire的api接口控制

    首先确保你的openfire已安装restapi 在openfire后台管理->插件管理中下载并启用restapi...

  • 专业名词

    on top of RestAPI :基于RestAPIPOM:project object model

  • RestApi初识

    Rest简介   2000年,Roy Thomas Fielding在他的博士论文中首次提出软件架构设计原则Res...

  • Spring Security项目Spring MVC开发RES

    查询请求 常用注解 @RestController 标明此Controller提供RestAPI @Request...

  • 2020-08-10

    https://m.stock.pingan.com/ai/restapi/center/?source=ping...

  • mesos APIs

    mesos 提供的 restapi master:可以使用http://192.168.56.101:5050/h...

  • 资源文件

    地址api: https://restapi.amap.com/v3/config/district?key=62...

  • 2020-04-02

    黑盒测试用例设计标准:设计大量的设计用例,使之覆盖软件中的所有输入输出接口白盒测试用例设计标准: 设计足够多的测试...

网友评论

      本文标题:RestAPI设计标准?

      本文链接:https://www.haomeiwen.com/subject/mzsovttx.html