Merge pull request #36 from link-duan/main

feat: 自定义响应参数类型按照顺序遍历防止生成的文档内容随机
gotomicro · Dec 6, 2022 · ae878a3 · ae878a3
2 parents 568e4ba + 9cef7db
commit ae878a3
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 18 deletions.
diff --git a/plugins/echo/handler_analyzer.go b/plugins/echo/handler_analyzer.go
@@ -10,6 +10,7 @@ import (
 	analyzer "github.com/gotomicro/eapi"
 	"github.com/gotomicro/eapi/plugins/common"
 	"github.com/gotomicro/eapi/spec"
+	"github.com/gotomicro/eapi/utils"
 	"github.com/iancoleman/strcase"
 	"github.com/robertkrimen/otto"
 	"github.com/samber/lo"
@@ -356,15 +357,19 @@ func (p *handlerAnalyzer) parseDataType(call *ast.CallExpr, dataType *common.Dat
 	case common.DataTypeObject:
 		schema := spec.NewObjectSchema()
 		properties := make(spec.Schemas)
-		for name, dataSchema := range dataType.Properties {
-			if !dataSchema.Optional {
-				schema.Required = append(schema.Required, name)
-			}
-			s := p.parseDataType(call, dataSchema, contentType)
-			if s != nil {
-				properties[name] = s
-			}
-		}
+		utils.RangeMapInOrder(
+			dataType.Properties,
+			func(a, b string) bool { return a < b },
+			func(name string, dataSchema *common.DataSchema) {
+				if !dataSchema.Optional {
+					schema.Required = append(schema.Required, name)
+				}
+				s := p.parseDataType(call, dataSchema, contentType)
+				if s != nil {
+					properties[name] = s
+				}
+			},
+		)
 		schema.Properties = properties
 		return spec.NewSchemaRef("", schema)
 	default: // fallback to js expression

diff --git a/plugins/gin/handler_analyzer.go b/plugins/gin/handler_analyzer.go
@@ -10,6 +10,7 @@ import (
 	analyzer "github.com/gotomicro/eapi"
 	"github.com/gotomicro/eapi/plugins/common"
 	"github.com/gotomicro/eapi/spec"
+	"github.com/gotomicro/eapi/utils"
 	"github.com/iancoleman/strcase"
 	"github.com/robertkrimen/otto"
 	"github.com/samber/lo"
@@ -373,15 +374,19 @@ func (p *handlerAnalyzer) parseDataType(call *ast.CallExpr, dataType *common.Dat
 	case common.DataTypeObject:
 		schema := spec.NewObjectSchema()
 		properties := make(spec.Schemas)
-		for name, dataSchema := range dataType.Properties {
-			if !dataSchema.Optional {
-				schema.Required = append(schema.Required, name)
-			}
-			s := p.parseDataType(call, dataSchema, contentType)
-			if s != nil {
-				properties[name] = s
-			}
-		}
+		utils.RangeMapInOrder(
+			dataType.Properties,
+			func(a, b string) bool { return a < b },
+			func(name string, dataSchema *common.DataSchema) {
+				if !dataSchema.Optional {
+					schema.Required = append(schema.Required, name)
+				}
+				s := p.parseDataType(call, dataSchema, contentType)
+				if s != nil {
+					properties[name] = s
+				}
+			},
+		)
 		schema.Properties = properties
 		return spec.NewSchemaRef("", schema)
 	default: // fallback to js expression