调试 / 文档模式

视频内容

调试模式

在项目开发初期，考虑到交付速度，开发人员会在制订业务需求之后直接进行代码开发，最终再通过代码生成 API 文档。这样的研发模式也称为 Code First 模式。

Apifox 中调试模式 专门面向 Code First 模式。当后端开发完业务代码之后，可以在调试模式下快捷地测试接口，并在调试的过程中由 Apifox 自动生成接口文档。调试模式适合习惯于先行进行接口参数调试，再生成接口文档的团队。在调试模式下，开发者只需要编辑界面中接口参数，修改后即可直接发送请求，保存后生成文档。

文档模式

相对于调试模式，文档模式更强调设计接口的重要性。“文档模式”面向 Design First 模式。采用 Design First 模式的研发团队首先专注于定义和规划 API 的结构、功能和行为。Design First 方法强调 API 作为一个独立的组件来设计，这个组件需要在未来多个应用程序和服务之间适应。

在“文档模式”中需要定义文档并保存，当接口发生变更时需要修改文档中的定义后再调试。