接口设计主要包括哪几个方面_实现接口必须实现接口的所有方法

接口设计主要包括哪几个方面_实现接口必须实现接口的所有方法api 接口设计原则有哪些?1、规范性:URL、参数、请求方式、返回值要有统一规范。首先,接口分为外部接口(客户端调用或公开API)和内部接口(后台服务间调用),内部接口url一般会多个”intern

api 接口设计原则有哪些?   1、规范性:   URL、参数、请求方式、返回值要有统一规范。首先,接口分为外部接口(客户端调用或公开API)和内部接口(后台服务间调用),内部接口url一般会多个”internal“或者”inner“,比如/v1/internal/XXX,URL中可以约定统一使用名词来拼接,一般按资源父子级的顺序从左往右写,名词统一单数还是复数都可以约定,参数和返回值字段是使用驼峰还是下划线,请求方式是否遵守restful接口规范,我见过有的项目接口不管查询还是设置接口统一post的,诸如此类,规范上可以约定的细节还有很多;   2、错误码:   错误码的规范也是一个很重要的点,特别是微服务项目,不同微服务的错误码要提前给定分区,避免CODE重复;   3、接口的职责明确:   要纯粹一点,尽量不要为了省接口数量几件事情或者几个流程合在一起做;   4、接口客户端使用场景和产品原型:   要理解客户端在需求中如何使用数据,出接口要考虑客户端的使用,尽量方便客户调用和解析数据;   5、安全性:   这是一般接口设计很容易忽略的点,参数侧的安全校验光注入攻击防护就有防SQL注入、命令注入、日志注入等等;对外公开的API还要考虑频繁调用的问题,一般可以设计IP锁,或者利用商业网关服务的策略配置来防护;鉴权也是一个很重要的点。

2024最新激活全家桶教程,稳定运行到2099年,请移步至置顶文章:https://sigusoft.com/99576.html

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请联系我们举报,一经查实,本站将立刻删除。 文章由激活谷谷主-小谷整理,转载请注明出处:https://sigusoft.com/20572.html

(0)
上一篇 2024年 9月 15日
下一篇 2024年 9月 15日

相关推荐

关注微信