bk-schema-checker 0.1.3 → 0.1.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bk-schema-checker",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "对照前端 services、Django REST 序列化器，以及可选的 bk-local-mock 响应，做接口协议检查。不启动 Django。",
   "type": "module",
   "author": "austinqli",
@@ -43,4 +43,4 @@
     "check": "node ./bin/bk-schema-checker.js",
     "test": "node --test test/"
   }
-}
+}

package/py/load_backend.py

@@ -1380,10 +1380,48 @@ class BackendLoader:
         schema = self.materialize(ref, mode, stack)
         if schema.get("type") == "array":
             return {"schema": schema, "many": True, "empty": False}
+        if not many and mode == "response" and isinstance(self.swagger_example(ref), list):
+            many = True
         if many:
             schema = {"type": "array", "items": schema}
         return {"schema": schema, "many": many, "empty": False}
 
+    def swagger_example(self, ref):
+        if not ref:
+            return None
+        meta = nested_class(ref.node, "Meta")
+        if not meta:
+            return None
+        node = class_assign(meta, "swagger_schema_fields")
+        if node is None:
+            return None
+        value = self.eval_const(node, ref.module, set())
+        if not isinstance(value, dict):
+            return None
+        return value.get("example")
+
+    def schema_from_swagger_example(self, ref):
+        example = self.swagger_example(ref)
+        if not isinstance(example, list):
+            return None
+        return {"type": "array", "items": self.example_item_schema(example), "required": True}
+
+    def example_item_schema(self, example):
+        if not example:
+            return any_schema()
+        first = example[0]
+        if isinstance(first, dict):
+            return {"type": "object", "fields": {}, "open": True, "required": True}
+        if isinstance(first, bool):
+            return {"type": "boolean", "required": True, "allowNull": False}
+        if isinstance(first, int):
+            return {"type": "integer", "required": True, "allowNull": False}
+        if isinstance(first, float):
+            return {"type": "number", "required": True, "allowNull": False}
+        if isinstance(first, str):
+            return {"type": "string", "required": True, "allowNull": False}
+        return any_schema()
+
     def materialize(self, ref, mode, stack):
         key = f"{ref.module.file}#{ref.name}"
         if key in stack:
@@ -1414,7 +1452,13 @@ class BackendLoader:
                 if mode == "response" and built.get("writeOnly"):
                     continue
                 fields[field_name] = built
-            return {"type": "object", "fields": fields, "serializer": ref.name, "required": True}
+            schema = {"type": "object", "fields": fields, "serializer": ref.name, "required": True}
+            if mode == "response" and not fields:
+                hinted = self.schema_from_swagger_example(ref)
+                if hinted:
+                    hinted.setdefault("serializer", ref.name)
+                    return hinted
+            return schema
         finally:
             stack.discard(key)