新建接口描述
接口描述可以被理解为是当前接口列表的 README 文件,通常以 Markdown 格式撰写,用于概括项目内提供的接口功能描述。
接口描述 markdown 文件还能用作在线文档的介绍页,帮助开发者、测试人员、用户等在需要时快速了解 API 的用途和行为。
新建 Markdown 文件
点击接口搜索栏右侧的 + 按钮,在下拉框中选择”新建 Markdown“按钮,输入文档名称后点击”确定“即可新建 Markdown 文档。
编辑接口描述
接口描述页完全兼容 Markdown 语法,Apifox 在顶部栏提供了便捷的编写组件,同时还支持实时预览。
发布为静态网页
将接口发布至在线文档后,Markdown 文件将直接变为静态网页。