基本介绍

GoFrame 框架支持全自动化的接口文档生成，保障代码与接口文档同步维护，自动生成的接口文档采用的是标准的 OpenAPIv3 协议。在介绍 OpenAPIv3 协议之前，建议您先阅读了解框架的规范路由特性： 路由注册-规范路由 。

相关文档

📄️ 接口文档-OpenAPIv3在GoFrame框架中使用OpenAPIv3协议来规范接口文档的生成。通过嵌入g.Meta元数据结构体，可以自动生成包含协议标签的接口信息。此外，文中还展示了如何自定义扩展标签和手动完善接口文档。

📄️ 接口文档-自定义UI在GoFrame框架中使用SwaggerUI自定义接口文档UI，以替代默认的Redoc组件UI。通过示例代码展示如何快速实现接口文档的替换，连接企业内部资源，避免外网依赖。详细演示了接口文档与第三方平台的对接，使用GoFrame Server进行UI模板切换，提升文档展示灵活性及可定制性。