zhangdeman/api-doc
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

upgrade: 优化部分代码, 部分内容待配置化

Browse Source
This commit is contained in:
白茶清欢
2025-08-23 01:09:57 +08:00
parent 14e56e4caf
commit bac8242f5e
19 changed files with 169 additions and 153 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
swagger/parser.go
View File

@ -10,12 +10,12 @@ package swagger
import (
"errors"
"fmt"
apiDocDefine "git.zhangdeman.cn/gateway/api-doc/define"
"git.zhangdeman.cn/zhangdeman/consts"
"git.zhangdeman.cn/zhangdeman/wrapper"
"net/http"
"sort"
"strings"
apiDocDefine "git.zhangdeman.cn/gateway/api-doc/define"
"git.zhangdeman.cn/zhangdeman/wrapper"
)
// HandleOpenapiDocRes ...

10
swagger/run.go
View File

@ -8,12 +8,12 @@
package swagger
import (
"git.zhangdeman.cn/gateway/api-doc/define"
"git.zhangdeman.cn/gateway/api-doc/util"
"git.zhangdeman.cn/zhangdeman/consts"
"git.zhangdeman.cn/zhangdeman/wrapper"
"net/http"
"strings"
"git.zhangdeman.cn/gateway/api-doc/define"
"git.zhangdeman.cn/gateway/api-doc/util"
"git.zhangdeman.cn/zhangdeman/wrapper"
)
// Generate 生成文档
@ -288,7 +288,7 @@ func generateParameterDefinitions(swaggerInfo *define.Swagger, uri string, paren
AllOf: nil,
}
if itemSwaggerDefinition.Type == consts.SwaggerDataTypeObject {
itemSwaggerDefinition.AllOf = []map[string]string{map[string]string{
itemSwaggerDefinition.AllOf = []map[string]string{{
consts.SwaggerRefKey: getRefValue(parentPath + "." + subPathArr[0]),
}}
} else if itemSwaggerDefinition.Type == consts.SwaggerDataTypeArray {

50
swagger/run_test.go
View File

@ -10,10 +10,10 @@ package swagger
import (
"encoding/json"
"fmt"
"git.zhangdeman.cn/gateway/api-doc/define"
"git.zhangdeman.cn/zhangdeman/consts"
"net/http"
"testing"
"git.zhangdeman.cn/gateway/api-doc/define"
)
func TestGenerate(t *testing.T) {
@ -37,7 +37,7 @@ func TestGenerate(t *testing.T) {
Version: "",
},
PathConfigList: []*define.SwaggerPathInput{
&define.SwaggerPathInput{
{
Uri: "/test",
Method: http.MethodPost,
ContentType: consts.MimeTypeJson,
@ -45,7 +45,7 @@ func TestGenerate(t *testing.T) {
Description: "测试接口",
TagList: []string{"测试接口生成"},
ParameterList: []*define.SwaggerParameterInput{
&define.SwaggerParameterInput{
{
Type: consts.DataTypeString.String(),
Description: "姓名",
Name: "name",
@ -53,7 +53,7 @@ func TestGenerate(t *testing.T) {
Required: true,
EnumList: []interface{}{"zhang", "de", "man"},
},
&define.SwaggerParameterInput{
{
Type: consts.DataTypeString.String(),
Description: "性别",
Name: "person.sex",
@ -61,7 +61,7 @@ func TestGenerate(t *testing.T) {
Required: true,
EnumList: []interface{}{"man", "woman", "other"},
},
&define.SwaggerParameterInput{
{
Type: consts.DataTypeString.String(),
Description: "性别",
Name: "person.job.list.[]",
@ -69,7 +69,7 @@ func TestGenerate(t *testing.T) {
Required: true,
EnumList: nil,
},
&define.SwaggerParameterInput{
{
Type: consts.DataTypeInt.String(),
Description: "年份",
Name: "person.job.year.[]",
@ -77,7 +77,7 @@ func TestGenerate(t *testing.T) {
Required: true,
EnumList: nil,
},
&define.SwaggerParameterInput{
{
Type: consts.DataTypeInt.String(),
Description: "测试工作",
Name: "person.job.test",
@ -85,7 +85,7 @@ func TestGenerate(t *testing.T) {
Required: true,
EnumList: nil,
},
&define.SwaggerParameterInput{
{
Type: consts.DataTypeInt.String(),
Description: "年龄",
Name: "age",
@ -93,7 +93,7 @@ func TestGenerate(t *testing.T) {
Required: true,
EnumList: []interface{}{18, 19, 20},
},
&define.SwaggerParameterInput{
{
Type: consts.DataTypeInt.String(),
Description: "年龄",
Name: "test_list.[].age",
@ -101,7 +101,7 @@ func TestGenerate(t *testing.T) {
Required: true,
EnumList: []interface{}{18, 19, 20},
},
&define.SwaggerParameterInput{
{
Type: consts.DataTypeString.String(),
Description: "年龄",
Name: "test_list.[].name",
@ -109,7 +109,7 @@ func TestGenerate(t *testing.T) {
Required: true,
EnumList: nil,
},
&define.SwaggerParameterInput{
{
Type: consts.DataTypeMapAnyAny.String(),
Description: "测试global_map",
Name: "obj",
@ -119,32 +119,32 @@ func TestGenerate(t *testing.T) {
},
},
ResponseList: []*define.SwaggerResponseInput{
&define.SwaggerResponseInput{
{
Code: "200",
Description: "成功",
List: []*define.SwaggerResponseItemInput{
&define.SwaggerResponseItemInput{
{
Type: consts.DataTypeString.String(),
Description: "姓名",
Field: "nick_name",
IsRequired: false,
},
&define.SwaggerResponseItemInput{
{
Type: consts.DataTypeString.String(),
Description: "昵称",
Field: "person.nick_name",
IsRequired: false,
},
&define.SwaggerResponseItemInput{
Type: consts.DataTypeMapAnyAny.String(),
Description: "测试返回生成map",
Field: "obj",
IsRequired: false,
IsRequired: false,
},
{
Type: consts.DataTypeMapAnyAny.String(),
Description: "测试返回生成map",
Field: "obj",
IsRequired: false,
},
},
},
},
},
},
},
},
},
})
byteData, _ := json.MarshalIndent(res, "", "\t")