Skip to main content

基于 OAS 和 Swagger 的 API 设计

RESTful API 开发时主要的协作方式就是 Design First + Code Update 的方式:

  1. Design First: 先给出 API 的初步设计, 通过 API 文档先提供给前端, 前端可以先根据文档实现, 而后台也可以通过文档生成初步接口, 然后同步开发.
  2. Code Update: 在实现过程中发现有不同的需求, 在代码中同步修改并生成新的文档, 这样可以继续开发并同步到文档.

这个系列的文章主要关注 RESTSful API 的设计过程, 以及设计过程和实现过程的衔接. 主要使用的工具是:

  • OAS 标准
  • Swagger 工具集
  • Golang 作为 RESTful API 的开发语言

参考: