网易nei接口管理解决方案.pdfVIP

⽹易NEI 接⼝管理解决 ⽅案 包勇明／⽹易杭研资深前端⼯程师 产品⼀共有多少个接⼝？ • ⼗年前端开发经验，曾在阿⾥巴巴、盛⼤ 创新院等公司任职，15年加⼊⽹易杭州研 究院 • NEI 产品负责⼈；对前端⼯程化、⾃动化 测试等领域有浓厚的兴趣 • 《单⻚Web应⽤：JavaScript 从前端到后 端》、《jQuery UI 开发指南》等书籍的译 者 包勇明 1. 产⽣背景 2. 解决⽅案 3. NEI 协作体系 4. NEI 的探索和成果 1. 产⽣背景 2. 解决⽅案 3. NEI 协作体系 4. NEI 的探索和成果 Web ⻚⾯的三要素 html Web css page js 软件⼯程师的分⼯ API 请求 前端 模板 后端 API 响应 分⼯后带来的问题 • 开发环境如何分离？ • 模板由谁开发？ • 前后端如何⾼效协作？ 分⼯后带来的问题 • 开发环境如何分离？ • 模板由谁开发？ • 前后端如何协作？ 开发环境为什么要分离 • 项⽬越来越复杂 • 修改html 模板，希望⽴即⽣效 • 前端有⾃⼰的IDE/编辑器偏好 分⼯后带来的问题 • 开发环境如何分离？ • 模板由谁开发？ • 前后端如何协作？ 模板职责不明确 • 模板中的html 结构是前端开发的 • 模板中的model 数据是后端注⼊的 分⼯后带来的问题 • 开发环境如何分离？ • 模板由谁开发？ • 前后端如何协作？ 前后端⾼效协作 • 通过异步接⼝通信 • 可以并⾏开发，没有依赖 • 联调成本⼩ 异步接⼝的别名 • API Contract ，中⽂名是API 契约 契约的含义 • 原指双⽅或多⽅共同协议订⽴的有关买卖、抵押、租赁等 关系的⽂书 • 可以理解为守信⽤ 需要解决的三个问题 • 开发环境如何分离？ • 模板由谁开发？ • 前后端如何协作？ 1. 产⽣背景 2. 解决⽅案 3. NEI 协作体系 4. NEI 的探索和成果 解决⽅案：开发环境如何分离 • 仍旧使⽤同个环境 • 前端开发静态⻚⾯，后端套⻚⾯ • 前端使⽤可以解析模板的模拟容器 解决⽅案：模板由谁开发 • 后端主导，前端协助 • 前端主导，后端协助 • 前端负责 解决⽅案：前后端如何协作 • 协定 API 契约 • 前端使⽤mock server • 后端使⽤postman、fiddler 等请求模拟⼯具 API 契约的形式 • IM、邮件 • Doc、Txt • Wiki 、Confluence • Swagger、API Blueprint API 契约的形式 • ⼝信！ NEI 的解决⽅案 • 模拟容器（开发环境） • 模板解析、模板Mock 数据