docs/web/api-document-openapiv3

[giscus[bot]]

docs/web/api-document-openapiv3

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

https://goframe.org/docs/web/api-document-openapiv3

[ninjashixuan]

validation rules 加上max min length 规则就好了，现在只有required 是用上，希望加上这样前端看文档就可以直接写自己的校验规则方便很多。

[gqcn]

可以一起共建哈，其实蛮简单的。如果实在不行也可以提个issue记录下，让社区的小伙伴一起来贡献。

[Starix610]

Schema 对象下的字段如何通过struct tag配置，比如想要配置Schema下的enum这个字段

type XxREq struct {
	Type string `json:"type" dc:"类型" schema:"???"`
}

[gqcn]

我建议通过枚举类型来维护，具体可以阅读相关文档：
https://goframe.org/docs/design/enums
https://goframe.org/docs/cli/gen-enums

[ninjashixuan]

想给 responses.200.content.application/json.schema 添加 ref，以及 data field 添加 ref，这种风格上的改动可以接受吗？。因为其他同事根据openapi 直接生成其他语言的调用代码，这个两个有 ref 会更好。可以的话，我提个 pr。