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

一、`OpenAPIv3`

详细的OpenAPIv3协议介绍请参考：https://swagger.io/specification/

二、`g.Meta`元数据

接口的元数据信息可以通过为输入结构体 embedded 方式嵌入 g.Meta 结构，并通过 g.Meta 的属性标签方式来实现。

关于元数据组件的介绍，详情请参考章节：元数据-gmeta

输入输出结构体中的属性的标签完整支持OpenAPIv3协议，因此只要增加了对应的协议标签，那么生成的OpenAPIv3接口信息中将会自动包含该属性。

大部分的标签属性已经被Server组件自动生成，开发者需要手动设置的标签不多。常见的标签包括：

常见OpenAPIv3标签	说明	备注
`path`	结合注册时的前缀共同构成接口URI路径	用于`g.Meta`标识接口元数据
`tags`	接口所属的标签，用于接口分类	用于`g.Meta`标识接口元数据
`method`	接口的请求方式：`GET/PUT/POST/DELETE…(不区分大小写)`	用于`g.Meta`标识接口元数据
`deprecated`	标记该接口废弃	用于`g.Meta`标识接口元数据
`summary`	接口/参数概要描述	缩写`sm`
`description`	接口/参数详细描述	缩写`dc`
`in`	参数的提交方式	`header/path/query/cookie`
`default`	参数的默认值	缩写`d`
`mime`	接口的`MIME`类型，例如`multipart/form-data`一般是全局设置，默认为`application/json`。	用于`g.Meta`标识接口元数据
`type`	参数的类型，一般不需要设置，特殊参数需要手动设置，例如`file`	仅用于参数属性