Merge pull request #44 from link-duan/main

feat(generators/ts): 类型名使用包名作为前缀

Author: link-duan

generators/umi/umi.go

@@ -318,6 +318,9 @@ func (p *Printer) jsDoc(item *spec.Operation) f.Doc {
 func (p *Printer) responseType(res *spec.Response) f.Doc {
 	for _, mediaType := range res.Content {
 		schema := mediaType.Schema
+		if schema == nil {
+			continue
+		}
 		schema = spec.Unref(p.schema, schema)
 		tsPrinter := ts.NewPrinter(p.schema).SetTypeFieldsInline(true)
 		ret := tsPrinter.PrintType(schema)

plugins/gin/testdata/server/docs/openapi.json

@@ -11,15 +11,15 @@
                         "type": "string"
                     }
                 },
-                "title": "Param",
+                "title": "GinParam",
                 "type": "object"
             },
             "github.com_gin-gonic_gin.Params": {
                 "description": "is a Param-slice, as returned by the router.\n\nThe slice is ordered, the first URL parameter is also the first slice value.\n\nIt is therefore safe to read values by the index.",
                 "items": {
                     "$ref": "#/components/schemas/github.com_gin-gonic_gin.Param"
                 },
-                "title": "Params",
+                "title": "GinParams",
                 "type": "array"
             },
             "server_pkg_view.ErrCode": {
@@ -30,7 +30,7 @@
                     10002,
                     10003
                 ],
-                "title": "ErrCode",
+                "title": "ViewErrCode",
                 "type": "integer"
             },
             "server_pkg_view.Error": {
@@ -42,7 +42,7 @@
                         "type": "string"
                     }
                 },
-                "title": "Error",
+                "title": "ViewError",
                 "type": "object"
             },
             "server_pkg_view.GoodsCreateReq": {
@@ -75,7 +75,7 @@
                     "title",
                     "price"
                 ],
-                "title": "GoodsCreateReq",
+                "title": "ViewGoodsCreateReq",
                 "type": "object"
             },
             "server_pkg_view.GoodsCreateRes": {
@@ -102,7 +102,7 @@
                         "type": "string"
                     }
                 },
-                "title": "GoodsCreateRes",
+                "title": "ViewGoodsCreateRes",
                 "type": "object"
             },
             "server_pkg_view.GoodsDownRes": {
@@ -111,7 +111,7 @@
                         "type": "string"
                     }
                 },
-                "title": "GoodsDownRes",
+                "title": "ViewGoodsDownRes",
                 "type": "object"
             },
             "server_pkg_view.GoodsInfoRes": {
@@ -131,7 +131,7 @@
                         "type": "string"
                     }
                 },
-                "title": "GoodsInfoRes",
+                "title": "ViewGoodsInfoRes",
                 "type": "object"
             },
             "server_pkg_view.Image": {
@@ -145,7 +145,7 @@
                 "required": [
                     "url"
                 ],
-                "title": "Image",
+                "title": "ViewImage",
                 "type": "object"
             },
             "server_pkg_view.Property": {
@@ -154,7 +154,7 @@
                         "type": "string"
                     }
                 },
-                "title": "Property",
+                "title": "ViewProperty",
                 "type": "object"
             },
             "server_pkg_view.SelfRefType": {
@@ -166,7 +166,7 @@
                         "$ref": "#/components/schemas/server_pkg_view.SelfRefType"
                     }
                 },
-                "title": "SelfRefType",
+                "title": "ViewSelfRefType",
                 "type": "object"
             }
         }

plugins/gin/testdata/server/frontend/src/requests/request.ts

@@ -1,17 +1,17 @@
 import { request } from "umi";
 import { 
-  GoodsCreateReq,
-  Params,
-  SelfRefType,
-  Property,
-  GoodsInfoRes
+  ViewGoodsCreateReq,
+  GinParams,
+  ViewSelfRefType,
+  ViewProperty,
+  ViewGoodsInfoRes
  } from "./types";
 
 /*
  * @description 创建商品接口
  */
-export function shopGoodsCreate(data: GoodsCreateReq) {
-  return request<{ Status?: Params; guid?: string; raw?: any; selfRef?: SelfRefType; stringAlias?: string; }>(`/api/goods`, {
+export function shopGoodsCreate(data: ViewGoodsCreateReq) {
+  return request<{ Status?: GinParams; guid?: string; raw?: any; selfRef?: ViewSelfRefType; stringAlias?: string; }>(`/api/goods`, {
     method: "post",
     data,
   });
@@ -43,13 +43,13 @@ export function shopGoodsDown(guid: string, data: { dateRange?: string[]; operat
  * @description 商品详情
  */
 export function shopGoodsInfo(guid: string) {
-  return request<{ cover?: string; mapInt?: Record<number, Property>; price?: number; properties?: Record<string, Property>; subTitle?: string; title?: string; }>(`/api/v2/goods/${guid}`, {
+  return request<{ cover?: string; mapInt?: Record<number, ViewProperty>; price?: number; properties?: Record<string, ViewProperty>; subTitle?: string; title?: string; }>(`/api/v2/goods/${guid}`, {
     method: "get",
   });
 }
 
 export function shopWrappedHandler(query: { hello?: string; world?: string }) {
-  return request<{ code: number; data: GoodsInfoRes; msg: string; }>(`/wrapped-handler`, {
+  return request<{ code: number; data: ViewGoodsInfoRes; msg: string; }>(`/wrapped-handler`, {
     method: "get",
     params: query,
   });

plugins/gin/testdata/server/frontend/src/requests/types.ts

@@ -1,7 +1,7 @@
 /*
  * @description is a single URL parameter, consisting of a key and a value.
  */
-export type Param = {
+export type GinParam = {
   Key?: string;
   Value?: string;
 }
@@ -11,29 +11,29 @@ export type Param = {
  *	The slice is ordered, the first URL parameter is also the first slice value.
  *	It is therefore safe to read values by the index.
  */
-export type Params = Param[]
+export type GinParams = GinParam[]
 
-export enum ErrCode {
+export enum ViewErrCode {
   CodeNotFound = 10000,
   CodeCancled = 10001,
   CodeUnknown = 10002,
   CodeInvalidArgument = 10003,
 }
 
-export type Error = {
-  code?: ErrCode;
+export type ViewError = {
+  code?: ViewErrCode;
   msg?: string;
 }
 
-export type GoodsCreateReq = {
+export type ViewGoodsCreateReq = {
   /*
    * @description 封面图
    */
   cover?: string;
   /*
    * @description 详情图
    */
-  images?: Image[];
+  images?: ViewImage[];
   /*
    * @description 价格(分)
    */
@@ -48,11 +48,11 @@ export type GoodsCreateReq = {
   title: string;
 }
 
-export type GoodsCreateRes = {
+export type ViewGoodsCreateRes = {
   /*
    * @description 测试引用第三方包
    */
-  Status?: Params;
+  Status?: GinParams;
   /*
    * @description 商品 GUID
    */
@@ -64,41 +64,41 @@ export type GoodsCreateRes = {
   /*
    * @description 测试循环引用
    */
-  selfRef?: SelfRefType;
+  selfRef?: ViewSelfRefType;
   /*
    * @description 测试类型别名
    */
   stringAlias?: string;
 }
 
-export type GoodsDownRes = {
+export type ViewGoodsDownRes = {
   Status?: string;
 }
 
-export type GoodsInfoRes = {
+export type ViewGoodsInfoRes = {
   cover?: string;
-  mapInt?: Record<number, Property>;
+  mapInt?: Record<number, ViewProperty>;
   price?: number;
-  properties?: Record<string, Property>;
+  properties?: Record<string, ViewProperty>;
   subTitle?: string;
   title?: string;
 }
 
 /*
  * @description 商品图片
  */
-export type Image = {
+export type ViewImage = {
   /*
    * @description 图片链接
    */
   url: string;
 }
 
-export type Property = {
+export type ViewProperty = {
   title?: string;
 }
 
-export type SelfRefType = {
+export type ViewSelfRefType = {
   data?: string;
-  parent?: SelfRefType;
+  parent?: ViewSelfRefType;
 }

plugins/gin/testdata/server/frontend/src/types/types.ts

@@ -1,7 +1,7 @@
 /*
  * @description is a single URL parameter, consisting of a key and a value.
  */
-export type Param = {
+export type GinParam = {
   Key?: string;
   Value?: string;
 }
@@ -11,29 +11,29 @@ export type Param = {
  *	The slice is ordered, the first URL parameter is also the first slice value.
  *	It is therefore safe to read values by the index.
  */
-export type Params = Param[]
+export type GinParams = GinParam[]
 
-export enum ErrCode {
+export enum ViewErrCode {
   CodeNotFound = 10000,
   CodeCancled = 10001,
   CodeUnknown = 10002,
   CodeInvalidArgument = 10003,
 }
 
-export type Error = {
-  code?: ErrCode;
+export type ViewError = {
+  code?: ViewErrCode;
   msg?: string;
 }
 
-export type GoodsCreateReq = {
+export type ViewGoodsCreateReq = {
   /*
    * @description 封面图
    */
   cover?: string;
   /*
    * @description 详情图
    */
-  images?: Image[];
+  images?: ViewImage[];
   /*
    * @description 价格(分)
    */
@@ -48,11 +48,11 @@ export type GoodsCreateReq = {
   title: string;
 }
 
-export type GoodsCreateRes = {
+export type ViewGoodsCreateRes = {
   /*
    * @description 测试引用第三方包
    */
-  Status?: Params;
+  Status?: GinParams;
   /*
    * @description 商品 GUID
    */
@@ -64,41 +64,41 @@ export type GoodsCreateRes = {
   /*
    * @description 测试循环引用
    */
-  selfRef?: SelfRefType;
+  selfRef?: ViewSelfRefType;
   /*
    * @description 测试类型别名
    */
   stringAlias?: string;
 }
 
-export type GoodsDownRes = {
+export type ViewGoodsDownRes = {
   Status?: string;
 }
 
-export type GoodsInfoRes = {
+export type ViewGoodsInfoRes = {
   cover?: string;
-  mapInt?: Record<number, Property>;
+  mapInt?: Record<number, ViewProperty>;
   price?: number;
-  properties?: Record<string, Property>;
+  properties?: Record<string, ViewProperty>;
   subTitle?: string;
   title?: string;
 }
 
 /*
  * @description 商品图片
  */
-export type Image = {
+export type ViewImage = {
   /*
    * @description 图片链接
    */
   url: string;
 }
 
-export type Property = {
+export type ViewProperty = {
   title?: string;
 }
 
-export type SelfRefType = {
+export type ViewSelfRefType = {
   data?: string;
-  parent?: SelfRefType;
+  parent?: ViewSelfRefType;
 }

schema.go

@@ -8,6 +8,7 @@ import (
 
 	"github.com/gotomicro/eapi/spec"
 	"github.com/gotomicro/eapi/tag"
+	"github.com/iancoleman/strcase"
 	"github.com/samber/lo"
 )
 
@@ -57,7 +58,7 @@ func (s *SchemaBuilder) FromTypeSpec(t *ast.TypeSpec) *spec.SchemaRef {
 		return nil
 	}
 	comment := ParseComment(s.ctx.GetHeadingCommentOf(t.Pos()))
-	schema.Value.Title = t.Name.Name
+	schema.Value.Title = strcase.ToCamel(s.ctx.Package().Name + t.Name.Name)
 	schema.Value.Description = strings.TrimSpace(comment.TrimPrefix(t.Name.Name))
 	schema.Value.Deprecated = comment.Deprecated()
 	return schema
@@ -139,6 +140,9 @@ func (s *SchemaBuilder) parseStruct(expr *ast.StructType) *spec.SchemaRef {
 		}
 
 		for _, name := range field.Names {
+			if !name.IsExported() {
+				continue
+			}
 			fieldSchema := s.ParseExpr(field.Type)
 			if fieldSchema == nil {
 				fmt.Printf("unknown field type %s at %s\n", name.Name, s.ctx.LineColumn(field.Type.Pos()))