接口规范 查询类接口使用GET,修改类接口(新增,修改,删除)使用POST 接口设计 http://{domain}/{end}/{resource}/{subresource} domain:服务域名; end:客户端;如:mp(卖家中心)、platform(erp后台)、publics(开放ap ...
转载 2021-10-21 09:52:00
294阅读
2评论
基本原则单一职责:一个接口只做一个行为,避免大而全的接口,避免出现根据入参控制接口行为的情况,这种情 接口的java
接口隔离原则一、设计模式的规范二、接口隔离原则三、示例非接口隔离原则(所有的方法都在一个接口里面)接口隔离原则(拆分接口)UML关系图 一、设计模式的规范设计模式遵循六⼤原则;单⼀职责( ⼀个类和⽅法只做⼀件事 )、⾥⽒替换( 多态,⼦类可扩展⽗类 )、依赖 倒置( 细节依赖抽象,下层依赖上层 )、接⼝隔离( 建⽴单⼀接⼝ )、迪⽶特原则( 最少知道,降低耦合 )、开闭 原则( 抽象架构,扩展实
1.RESTful接口设计规范是什么? RESTful 接口设计规范是一种设计和构建网络服务的标准方式,它依赖于 HTTP 协议,注重简洁和可扩展性。 2.为什么要使用RESTful接口设计规范? 使用 RESTful 接口设计规范有助于创建高效、易于理解和扩展的网络服务。它基于 HTTP 协议,利用标准动词(如 GET、POST)进行资源操作,使接口设计简洁一致,便于开发和维护。RESTful
原创 6天前
31阅读
说明:在实际的业务中,难免会跟第三方系统进行数据的交互与传递,那么如何保证数据在传输过程中的安全呢(防窃取)?除了https的协议之外,能不能加上通用的一套算法以及规范来保证传输的安全性呢?下面我们就来讨论下常用的一些API设计的安全方法,可能不一定是最好的,有更牛逼的实现方式,但是这篇是我自己的经验分享.一、token 简介Token:访问令牌access token, 用于接口中, 用于标识接
原创 2023-07-28 14:31:06
111阅读
概述这篇文章分享 API 接口设计规范,目的是提供给研发人员做参考。规范是死的,人是活的,希望自己定的规范,不要被打脸。路由命名规范动作前缀备注获取getget{XXX}获取getget{XXX}List新增addadd{XXX}修改updateupdate{XXX}保存savesave{XXX}删除deletedelete{XXX}上传uploadupload{XXX}发送sendsend{XX
原创 2023-08-10 14:40:18
134阅读
概述 这篇文章分享 API 接口设计规范,目的是提供给研发人员做参考。 规范是死的,人是活的,希望自己定的规范,不要被打脸。 路由命名规范 动作 前缀 备注 获取 get get{XXX} 获取 get get{XXX}List 新增 add add{XXX} 修改 update update{XX
概述 这篇文章分享 API 接口设计规范,目的是提供给研发人员做参考。 规范是死的,人是活的,希望自己定的规范,不要被打脸。 路由命名规范 动作 前缀 备注 获取 get get{XXX} 获取 get get{...
概述 这篇文章分享 API 接口设计规范,目的是提供给研发人员做参考。 规范是死的,人是活的,希望自己定的规范
转载 2020-09-25 15:32:00
243阅读
2评论
...
转载 2020-03-23 07:35:00
263阅读
2评论
情 restful 接口设计规范 1.URL中不能有动词,只能是名词 说明: restful风格将应该遵循统
原创 2022-10-15 00:32:23
1088阅读
那么接口在开始之前,你觉得需要有哪些规范呢?下面我就介绍一下以前我在公司开展接口项目时,制定的一些针对接口项目的约定规范。(当然不同公司可以根据公司文化、项目差异自行制定,不一定我们的就是最好的,找到一套适合自己的才是关键)
原创 2021-07-08 14:25:34
257阅读
# Java 接口设计规范 ## 1. 引言 Java 接口是一种定义类之间交互的契约,它规定了类要实现的方法和属性。良好的接口设计能够提高代码的可读性和可维护性,减少代码耦合度。本文旨在向刚入行的开发者介绍如何实现 Java 接口设计规范。 ## 2. 实现步骤 下表展示了实现 Java 接口设计规范的步骤: | 步骤 | 描述 | |---|---| | 步骤 1 | 确定接口的目的
原创 7月前
135阅读
优秀的设计是产品变得卓越的原因。设计API意味着提供有效的接口,可以帮助API使用者更好地了解、使用和集成,同时帮助人们有效地维护它。每个产品都需要使用手册,API也不例外。
推荐 原创 2021-07-05 10:15:30
4252阅读
3点赞
接口(API)设计规范一、接口(API)设计规范1.1 基本规范1.1.1 公共参数1.1.2 响应数据1.1.3 字段类型规范1.1.4 上传/下载1.1.5 避免精度丢失
1. 前言 继前面一章《RobotFramework环境搭建》介绍了在本地如何将接口自动化实施过程所需要的基础环境搭建好,在这里假设大家都已经知道环境如何搭建了,如果不清楚的可直接查看上一章节 RobotFrameWork环境搭建(基于HTTP协议的接口自动化),那么环境一切ready了,是不是代表
转载 2021-04-23 21:06:18
238阅读
    1前言    继前面一章《RobotFramework环境搭建》介绍了在本地如何将接口自动化实施过程所需要的基础环境搭建好,在这里假设大家都已经知道环境如何搭建了,如果不清楚的可直接查看上一章节 RobotFrameWork环境搭建(基于HTTP协议的接口自动化),那么环境一切ready了,是不是代表就可以开干了呢?    不急,对于一个team在开展这类大工程的时候,要考虑到团队多人协作
原创 2021-04-25 15:16:11
247阅读
概述这篇文章分享 API 接口设计规范,目的是提供给研发人员做参考。规范是死的,人是活的,希望自己定的规范,不要被打脸。路由命名规范动作前缀备注获取getget{XXX}获取getget{XXX}List新增addadd{XXX}修改updateupdate{XXX}保存savesave{XXX}删除deletedelete{XXX}上传uploadupload{XXX}发送sendsend{XX
原创 2021-04-27 16:37:28
1538阅读
1. 协议 API 和用户的交流协议,必须使用HTTPs。 2. 范围 API 应当部署在专用范围名称下。 3. 版本 URL地址里面应当包括API 版本号。 正确示例 v1, v2, v3 错误示例 v-1, 1.2 4. 端点 端点是API的特殊URL,在Restful架构范围内,每个URL代表一个资源,因此URL里面没有动词,只
网络应用程序,分为前端和后端两个部分。当前的发展趋势,就是前端设备层出不穷(手机、平板、桌面电脑、其他专用设备…)。因此,必须有一种统一的机制,方便不同的前端设备与后端进行通信。这导致API构架的流行,甚至出现"API First"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序
转载 2020-06-15 23:51:00
7201阅读
2评论
  • 1
  • 2
  • 3
  • 4
  • 5