So-蒋民学
在微服务、前后端分离的架构模式下，绝大多数项目或多或少都会调用第三方API或者提供API给第三方调用。特别是我们自己作为API服务方时，API的设计规范很重要，一个设计良好的API要求具备语义性，一看就懂，简洁明了。
API接口返回格式如何选择？
API接口返回数据的格式有很多种，比如说：纯文本、XML、JSON、二进制数据等。但从直观性上说，因为返回的数据大多是结构化数据，所以XML和JSON格式返回较为直观。
但从性能上考虑，JSON更轻量级，所以当前API返回数据格式几乎99%是返回JSON字符串的。
API返回数据需要包含哪些元素？
1、CODE状态码
此状态码用来标识当前请求的状态，这样便于快速定位问题。可以参考HTTP状态码划分一个数字段来表示特定的操作状态，如：
200：正常
-
1000~1999：参数级错误
2000~2999：逻辑错误
3000~3999：代码异常及错误
2、消息文本
此字段主要用于对错误的描述，正常响应时此字段为空，一旦有错误时会提示具体的错误原因。
3、数据结构体
此数据结构体就是调用方需要调用的数据，不同业务它所包含的字段不同。
以上就是我的观点，对于这个问题大家是怎么看待的呢？欢迎在下方评论区交流 ~ 我是科技领域创作者，十年互联网从业经验，欢迎关注我了解更多科技知识！网络圈
返回状态码、状态码描述信息、数据。这样调用者可以用状态码处理异常，描述消息展现给客户或记录日志。
分享到:
