接口规范文档设计

接口分数计算:

总分组成 规则【每项均分】 说明 备注

正常规则:总分100

设计分60

存在领域或分类根目录 解析目录URI目录下应用有主体概念设置【针对接口所在分类(接口集合)】

以接口路径的版本号为分隔,接口分类下所有的接口版本左侧内容一致即该分类下所有接口都有分;没有版本号或者左侧内容不一致则该分类下所有接口均无分。

有分例子:
       分类A下有2个接口:
               1. /basicapi/operate/manage/v1/latest/

                2. /basicapi/operate/manage/v1/list/

无分例子:

   分类B下有2个接口:
               1. /aa/operate/manage/v1/latest/

                2. /vb/operate/manage/v1/list/

接口所在分类接口数量不超过10个 接口所在的分类下接口数量 接口所在的分类下接口数量大于10则该分类下所有接口均无分。反之该分类下所有接口都有分
接口存在版本概念 接口路径存在v1或v2内容

有分例子:/basicapi/operate/manage/v1/latest/

无分例子:/basicapi/operate/manage/vvvv/latest/

存在明确的聚合根 接口路径中版本后为单一单词
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 2
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值