怎样设计接口

Posted yutingliuyl

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了怎样设计接口相关的知识,希望对你有一定的参考价值。

依据资料和经验总结。

要求:

  1. 命名:
    1. 命名规则和风格统一、规范;
    2. 命名清晰明白,不冗余,不模糊;
    3. 有意义:清晰和有意义的命名比简略而模糊的命名更应受到青睐;
  1. 功能
    1. 职责明白:功能尽量单一;
    2. 充分理由:不要随便有新功能就添加新接口;无意义的接口仅仅会添加维护的难度;
    3. 将功能层和策略层分开:
      1. 功能是基础数据。不易变。
      2. 策略是表层数据,易变——策略能够使用參数改动;
    1. 低耦合:降低不同接口间的依赖。
      1. 一个接口不应随着还有一个接口的变化而变化;
      2. 一个接口不应以某几个接口为前提而存在。
    1. 完备性:
      1. 考虑各种參数变化的情况。
      2. 考虑各种參数为default或为0的情况。
    1. 可扩展性:为以后可能会添加的參数预留余地,尽量不要写死;
  1. 參数
    1. 不超过5个;
    1. 从做到右,依照參数easy变化的程度排列;
    2. 尽量提供默认值;
    3. 若超过5个,把相似的数据放入到一个jsonlist等数据结构中;
    4. 禁止任意扩展:理由见“功能”部分。
    5. 參数尽量是原生数据结构。少用对平台依赖的数据结构。
  1. 分析角度:明白角度,不要一会以角色设计,一会以功能设计。
  2. 必要信息:
    1. 初始信息
      1. 初始化是否完成
      2. 初始化完成后的基本信息(如:listdict的长度——能够看出是否为0
    1. 中间信息
      1. 数据源是否变动
      2. 数据长度是否改变(须要视重要程度决定是否需打印该信息)
    1. 返回信息
      1. 是否成功?
      2. 失败原因?

 

 

 

參考文献:

  1. http://www.yixieshi.com/zhichang/14567.html

以上是关于怎样设计接口的主要内容,如果未能解决你的问题,请参考以下文章

什么是接口测试?怎样做接口测试?

怎样扩展Chromium各层的接口

[异步][事务][流程][设计]同步当场处理并返回处理结果,异步后怎样返回. 怎样解决?

什么是接口测试?怎样做接口测试?

什么是接口测试?怎样做接口测试?

性能指标要求 300次/s TPS,响应时间100ms,无页面接口测试,使用jmeter