API开发流程

API就是操作系统留给应用程序的一个调用接口，应用程序通过调用操作系统的 API 而使操作系统去执行应用程序的命令。以下讲述了项目中心、方案评审、技术方案、项目搭建、编码开发。

API开发流程

• 项目中心
  • 拆分需求,对应的任务
  • 每日更新任务状态
• 方案评审
  • 产品方案
    • 关键点探讨
    • 需求必要性,可行性
  • UI 设计
  • 技术方案
    • 可行性探讨
    • 依赖分析
    • API设计
  • 测试用例
    • 测试边界
    • 测试条件
    • 预期效果
  • 安全审核
    • 权限控制
    • 数据隐私
    • 接口安全
    • 行业法规
• 技术方案
  • 数据流转链路
    • 硬件
    • 大数据
    • 平台
    • 开发者
  • 关键技术点
    • 中间件消息流转
    • 数据容量预估
    • 业务消息推送
  • 关键风险点
    • 外部依赖延期风险
  • 数据安全
    • 隐私数据加解密
    • 对外数据合规
  • 限流分析
    • 数据容量
    • 业务并发
  • 幂等性分析
    • 关键业务
  • 团队协作时间
    • 各部门成员时间协调
  • RestAPI编写
    • API-权限控制
    • API-URL命名规范
    • 请求类型,参数类型,参数命名,响应结构
    • 异常业务状态码提示
  • 数据库表设计
    • 业务主体,关系分析
    • 数据表设计,索引控制
  • 上线时间
    • 各阶段成果确认
    • 风险点分析
• 项目搭建
  • 权限申请
    • 通用存储
    • kafka
    • plusar
    • ecs
    • mysql
    • git
  • 搭建项目
    • 脚手架
    • 公用配置
    • apollo
  • 环境设置
    • dev,daily,项目,pre,prod
  • 分支管理
    • 各环境分支
  • 资源准备
    • 数据库
    • 服务器
    • 中间件
  • 环境测试
    • 心跳检测
• 编码开发
  • DDD开发模型
  • 数据库初始化
    • DMS各环境执行
  • 代码生成工具
    • mybatis-plus
  • API层定义
    • 文档,网关API生成注解
    • URL,入参,规范注释
  • 参数转换
    • DDD分层参数转换
  • 参数校验
    • 各API入参严格校验,控制边界,默认值
  • 事物控制
    • 涉及数据库非读操作
  • 业务校验
    • 关键业务约束性校验
  • 多线程
    • 复杂业务,考虑并行串行,线程池
  • 分层测试
    • 分层mock
  • 链路测试
    • 全链路测试API请求响应
      • kibana-日志查询
      • skywalking-链路追踪
  • mq
    • kafka
      • 消费者
        • confirm模式
        • 重试次数
        • trace-skywalking
      • 生产者
        • dev手动投递
    • plusar
      • phoinex统一透出
  • 文档编写
    • 研测平台文档编写
      • 接口描述清晰
      • 参数示例,描述准确
      • 请求响应示例
        • 关键值模糊
    • 文档Review
      • 官网上架复查
  • 前端联调
  • 辅助测试
    • 模拟数据
    • 问题定位
    • bug修复