diff --git a/define/openapi.go b/define/openapi.go index 462619d..084369f 100644 --- a/define/openapi.go +++ b/define/openapi.go @@ -263,12 +263,12 @@ type Response struct { // // Date : 16:10 2024/4/19 type Info struct { - Description string `json:"description"` // 对应用的简短描述。 CommonMark syntax 可以被用来表示富文本呈现。 - Title string `json:"title" required:"true"` // 必选. 应用的名称。 - TermsOfService string `json:"termsOfService"` // 指向服务条款的 URL 地址,必须是 URL 地址格式。 - Contact Contact `json:"contact"` // 联系方式 - License License `json:"license"` // 开源协议 - Version string `json:"version" required:"true"` // 必选. API 文档的版本信息(注意:这个版本和开放 API 规范版本没有任何关系)。 + Description string `json:"description"` // 对应用的简短描述。 CommonMark syntax 可以被用来表示富文本呈现。 + Title string `json:"title" required:"true"` // 必选. 应用的名称。 + TermsOfService string `json:"termsOfService"` // 指向服务条款的 URL 地址,必须是 URL 地址格式。 + Contact *Contact `json:"contact,omitempty"` // 联系方式 + License *License `json:"license,omitempty"` // 开源协议 + Version string `json:"version" required:"true"` // 必选. API 文档的版本信息(注意:这个版本和开放 API 规范版本没有任何关系)。 } // Contact 联系人信息 diff --git a/generate.go b/generate.go new file mode 100644 index 0000000..750a1a7 --- /dev/null +++ b/generate.go @@ -0,0 +1,54 @@ +// Package api_doc ... +// +// Description : api_doc ... +// +// Author : go_developer@163.com<白茶清欢> +// +// Date : 2024-07-22 15:55 +package api_doc + +import ( + "git.zhangdeman.cn/gateway/api-doc/define" + "git.zhangdeman.cn/zhangdeman/consts" +) + +// NewOpenapiDoc ... +// +// Author : go_developer@163.com<白茶清欢> +// +// Date : 15:56 2024/7/22 +func NewOpenapiDoc() *Generate { + return &Generate{ + docData: &define.OpenapiDoc{ + Openapi: consts.SwaggerDocVersion3, + Info: &define.Info{ + Description: "openapi接口文档", + Title: "openapi接口文档", + TermsOfService: "", + Contact: &define.Contact{ + Name: "", + Url: "", + Email: "", + }, + License: &define.License{ + Name: "", + Url: "", + }, + Version: "", + }, + Servers: nil, + Components: nil, + Tags: nil, + Paths: nil, + }, + } +} + +// Generate 文档生成实例 +// +// Author : go_developer@163.com<白茶清欢> +// +// Date : 15:57 2024/7/22 +type Generate struct { + docData *define.OpenapiDoc +} diff --git a/go.mod b/go.mod index 7c474ad..c666a77 100644 --- a/go.mod +++ b/go.mod @@ -3,7 +3,7 @@ module git.zhangdeman.cn/gateway/api-doc go 1.22.2 require ( - git.zhangdeman.cn/zhangdeman/consts v0.0.0-20240425091616-00e0a924efcd + git.zhangdeman.cn/zhangdeman/consts v0.0.0-20240722080005-ca68a3ff8bc7 git.zhangdeman.cn/zhangdeman/wrapper v0.0.0-20240422034417-8c922be06d95 ) diff --git a/go.sum b/go.sum index 99d3741..5bdc1db 100644 --- a/go.sum +++ b/go.sum @@ -1,5 +1,7 @@ git.zhangdeman.cn/zhangdeman/consts v0.0.0-20240425091616-00e0a924efcd h1:RBFDiEMI97fuzpyb5HBN4lu3UXTAGYo6nlGhV2gWq5U= git.zhangdeman.cn/zhangdeman/consts v0.0.0-20240425091616-00e0a924efcd/go.mod h1:IXXaZkb7vGzGnGM5RRWrASAuwrVSNxuoe0DmeXx5g6k= +git.zhangdeman.cn/zhangdeman/consts v0.0.0-20240722080005-ca68a3ff8bc7 h1:8wJlcuJPhEHKdNIENvcxGiZwwOgjclvKwgKt/MU6WWI= +git.zhangdeman.cn/zhangdeman/consts v0.0.0-20240722080005-ca68a3ff8bc7/go.mod h1:IXXaZkb7vGzGnGM5RRWrASAuwrVSNxuoe0DmeXx5g6k= git.zhangdeman.cn/zhangdeman/easymap v0.0.0-20240311030808-e2a2e6a3c211 h1:I/wOsRpCSRkU9vo1u703slQsmK0wnNeZzsWQOGtIAG0= git.zhangdeman.cn/zhangdeman/easymap v0.0.0-20240311030808-e2a2e6a3c211/go.mod h1:SrtvrQRdzt+8KfYzvosH++gWxo2ShPTzR1m3VQ6uX7U= git.zhangdeman.cn/zhangdeman/serialize v0.0.0-20240325080031-1f58204e8687 h1:uQcGqdzi4UdpZlp4f4FUPeBqoygP58pEKJkmN3ROsE0=