feat: request

Author: alovn

examples/common/response.go

@@ -0,0 +1,9 @@
+package common
+
+type Response struct {
+	Code    int
+	Msg     string
+	Data    interface{}
+	Common  float64
+	Common2 string
+}

examples/docs/apis-greeter.md

@@ -4,41 +4,60 @@ greeter分组说明
 
 ## Apis
 
-### 测试greeter
+### @api 测试greeter
 
 ```text
 GET /greeter
 ```
 
+**Request**:
+parameters|type|required|validate|example|description
+--|--|--|--|--|--
+**id**|*header,query*|true||12357|this id
+**tid**|*param*|true|required|123|
+**token**|*header*|false||"example"|
 **Response**:
 
 ```json
 // StatusCode: 200
 
 // 输出对象 dd
-{  //object(main.Response), 通用返回结果
-  "code": 0,  //int, 返回状态码
+{  //object(common.Response)
+  "Code": 123,  //int
+  "Common": 1.23,  //float64
+  "Common2": "example",  //string
+  "Data": null,  //any
+  "Msg": "example",  //string
   "data": {  //object(main.TestData)
     "MyIntArray": [  //array[int]
-      0
+      123
     ],
     "MyTestData2Array": [  //array[main.TestData2]
       {  //object(main.TestData2)
-        "MyAge2": 0,  //int
+        "MyAge2": 123,  //int
         "MyTitle2": "example"  //string, 标题2
       }
     ],
     "data2": {  //object(main.TestData2)
-      "MyAge2": 0,  //int
+      "MyAge2": 123,  //int
       "MyTitle2": "example"  //string, 标题2
     },
     "my_title": "example"  //string, 标题
-  },
-  "msg": "返回消息"  //string, 返回文本消息
+  }
+}
+```
+
+```json
+// StatusCode: 500
+
+// 出错了
+{  //object(main.Response), 通用返回结果
+  "code": 10010,  //int, 返回状态码
+  "msg": "异常",  //string, 返回文本消息
 }
 ```
 
-### 测试greeter2
+### @api 测试greeter2
 
 ```text
 GET /greeter2
@@ -52,16 +71,16 @@ GET /greeter2
 // 输出对象 dd
 {  //object(main.TestData)
   "MyIntArray": [  //array[int]
-    0
+    123
   ],
   "MyTestData2Array": [  //array[main.TestData2]
     {  //object(main.TestData2)
-      "MyAge2": 0,  //int
+      "MyAge2": 123,  //int
       "MyTitle2": "example"  //string, 标题2
     }
   ],
   "data2": {  //object(main.TestData2)
-    "MyAge2": 0,  //int
+    "MyAge2": 123,  //int
     "MyTitle2": "example"  //string, 标题2
   },
   "my_title": "example"  //string, 标题

examples/docs/apis-hello.md

@@ -4,15 +4,15 @@
 
 ## Apis
 
-### 测试hello
+### @api 测试hello
 
 ```text
 GET /hello
 ```
 
 **Response**:
 
-### 测试hello2
+### @api 测试hello2
 
 ```text
 GET /hello2

examples/docs/apis-ungrouped.md

@@ -4,7 +4,7 @@ Ungrouped apis
 
 ## Apis
 
-### 测试other
+### @api 测试other
 
 ```text
 GET /other

examples/main.go

@@ -1,6 +1,10 @@
 package main
 
-import "fmt"
+import (
+	"fmt"
+
+	"github.com/alovn/apidoc/examples/common"
+)
 
 //@title svc-greeter
 //@desc greeter接口文档
@@ -24,11 +28,11 @@ type Response struct {
 	Data interface{} `json:"data,omitempty"`               //返回的具体数据
 } //通用返回结果
 
-type TestData2 struct { //测试数据2
+type TestData2 struct {
 	MyTitle2 string //标题2
 	MyAge2   int
 }
-type TestData struct { //测试数据
+type TestData struct {
 	MyTitle string     `json:"my_title,omitempty"` //标题
 	Data2   *TestData2 `json:"data2,omitempty"`
 	// MyIntData  int
@@ -39,23 +43,24 @@ type TestData struct { //测试数据
 }
 
 type Request struct {
-	ID    int    `query:"id"`
-	TID   int    `param:"tid"`
+	ID    int    `query:"id" header:"id" required:"true" example:"12357"` //this id
+	TID   int    `param:"tid" validate:"required"`
 	Name  string `json:"name,omitempty"`
 	Token string `header:"token"`
-}
+} //请求对象
 
 //@title 测试greeter
 //@api GET /greeter
 //@group greeter
 //@accept json
 //@request Request
-//@response 200 Response{data=TestData} 输出对象 dd
-//@response1 500 Response{code=10010,msg="异常"} 出错了
+//@response 200 common.Response{data=TestData} 输出对象 dd
+//@response 500 Response{code=10010,msg="异常"} 出错了
 //@response1 500 int 错误
-func greet() {
+func greet() *common.Response {
 	var msg = "Hello World!"
 	fmt.Println(msg)
+	return &common.Response{}
 }
 
 //@title 测试greeter2

gen/template/group_apis.tpl

@@ -4,14 +4,18 @@
 
 ## Apis
 {{range $k,$v := .Apis}}
-### {{$v.Title}}
+### @api {{$v.Title}}
 {{if $v.Author}}
 author: {{$v.Author}}
 {{end}}
 ```text
 {{$v.HTTPMethod}} {{$v.Api}}
 ```
-
+{{if $v.Requests.Parameters}}
+**Request**:
+parameters|type|required|validate|example|description
+--|--|--|--|--|--{{range $p:= $v.Requests.Parameters}}
+**{{$p.Name}}**|*{{$p.Types}}*|{{$p.Required}}|{{$p.Validate}}|{{$p.Example}}|{{$p.Description}}{{end}}{{end}}
 **Response**:
 {{range $res := $v.Responses}}
 ```json

operation.go

@@ -13,7 +13,7 @@ var (
 	// responsePattern = regexp.MustCompile(`^(\d+)\s+([\w\-.\\{}=,\[\]]+)\s+(.*)?`)
 	responsePattern = regexp.MustCompile(`^(\d+)\s+([\w\-.\\{}=,\"\[\]]+|[\w.]+{.*?})\s+(.*)?`)
 	// responsePattern = regexp.MustCompile(`^([\w,]+)\s+([\w{}]+)\s+([\w\-.\\{}=,\[\]]+)[^"]*(.*)?`)
-
+	requestPattern = regexp.MustCompile(`([\w\-.\\\[\]]+)\s*(.*)?`)
 	// ResponseType{data1=Type1,data2=Type2}.
 	combinedPattern = regexp.MustCompile(`^([\w\-./\[\]]+){(.*)}$`)
 )
@@ -66,6 +66,8 @@ func (operation *Operation) ParseComment(comment string, astFile *ast.File) erro
 		operation.ParseTagsComment(lineRemainder)
 	case apiAttr:
 		return operation.ParseRouterComment(lineRemainder)
+	case requestAttr:
+		return operation.ParseRequestComment(lineRemainder, astFile)
 	case successAttr, failureAttr, responseAttr:
 		return operation.ParseResponseComment(lineRemainder, astFile)
 	case deprecatedAttr:
@@ -113,6 +115,48 @@ func (operation *Operation) ParseRouterComment(commentLine string) error {
 	return nil
 }
 
+func (operation *Operation) ParseRequestComment(commentLine string, astFile *ast.File) error {
+	fmt.Println("Reqquest comment-------" + commentLine)
+	matches := requestPattern.FindStringSubmatch(commentLine)
+	//0 Request 1 Request 2 Comment
+	if len(matches) != 3 {
+		return nil
+	}
+	refType := matches[1]
+	switch {
+	case IsGolangPrimitiveType(refType):
+		return nil
+	default:
+		schema, err := operation.parser.getTypeSchema(refType, astFile, nil, true)
+		if err != nil {
+			return err
+		}
+		if schema == nil || schema.Properties == nil {
+			return nil
+		}
+		operation.Requests = ApiRequestSpec{
+			Parameters: map[string]*ApiParameterSpec{},
+		}
+		for _, p := range schema.Properties {
+			for pType, pName := range p.Tags {
+				if param, ok := operation.Requests.Parameters[pName]; ok {
+					param.types = append(param.types, pType)
+				} else {
+					operation.Requests.Parameters[pName] = &ApiParameterSpec{
+						Name:        pName,
+						Required:    p.Required,
+						Description: p.Comment,
+						Validate:    p.Validate,
+						Example:     p.Example,
+						types:       []string{pType},
+					}
+				}
+			}
+		}
+		return nil
+	}
+}
+
 // ParseResponseComment parses comment for given `response` comment string.
 func (operation *Operation) ParseResponseComment(commentLine string, astFile *ast.File) error {
 	operation.parser.clearStructStack()

parser.go

@@ -21,6 +21,7 @@ const (
 	versionAttr     = "@version"
 	descriptionAttr = "@desc"
 	acceptAttr      = "@accept"
+	requestAttr     = "@request"
 	successAttr     = "@success"
 	failureAttr     = "@failure"
 	responseAttr    = "@response"
@@ -358,11 +359,14 @@ func (parser *Parser) getTypeSchema(typeName string, file *ast.File, field *ast.
 		return &TypeSchema{
 			Name:        name,
 			FieldName:   fieldName,
-			Comment:     field.Comment.Text(),
+			Comment:     strings.TrimSuffix(field.Comment.Text(), "\n"),
 			FullName:    name,
 			Type:        typeName,
 			Example:     getFieldExample(typeName, field),
 			IsOmitempty: isOmitempty,
+			Validate:    getValidateTagValue(field),
+			Tags:        getParameterTags(field),
+			Required:    getRequiredTagValue(field),
 		}, nil
 	}
 
@@ -549,83 +553,6 @@ func (parser *Parser) parseStructField(file *ast.File, field *ast.Field) (*TypeS
 		}
 		return schema, nil
 	}
-
-	// if field.Names == nil {
-	// 	typeName, err := getFieldType(field.Type)
-	// 	if err != nil {
-	// 		return nil, err
-	// 	}
-
-	// 	schema, err := parser.getTypeSchema(typeName, file, false)
-	// 	if err != nil {
-	// 		return nil, err
-	// 	}
-
-	// 	if len(schema.Type) > 0 && schema.Type == OBJECT {
-	// 		if len(schema.Properties) == 0 {
-	// 			return nil, nil
-	// 		}
-
-	// 		properties := map[string]*TypeSchema{}
-	// 		for k, v := range schema.Properties {
-	// 			properties[k] = v
-	// 		}
-
-	// 		return properties, nil
-	// 	}
-
-	// 	// for alias type of non-struct types ,such as array,map, etc. ignore field tag.
-	// 	// return map[string]*TypeSchema{Type: typeName}, nil, nil
-	// }
-
-	// ps := parser.fieldParserFactory(parser, field)
-
-	// if ps.ShouldSkip() {
-	// 	return nil, nil, nil
-	// }
-
-	// fieldName, err := ps.FieldName()
-	// if err != nil {
-	// 	return nil, nil, err
-	// }
-
-	// schema, err := ps.CustomSchema()
-	// if err != nil {
-	// 	return nil, nil, err
-	// }
-
-	// if schema == nil {
-	// 	typeName, err := getFieldType(field.Type)
-	// 	if err == nil {
-	// 		// named type
-	// 		schema, err = parser.getTypeSchema(typeName, file, true)
-	// 	} else {
-	// 		// unnamed type
-	// 		schema, err = parser.parseTypeExpr(file, field.Type, false)
-	// 	}
-
-	// 	if err != nil {
-	// 		return nil, nil, err
-	// 	}
-	// }
-
-	// err = ps.ComplementSchema(schema)
-	// if err != nil {
-	// 	return nil, nil, err
-	// }
-
-	// var tagRequired []string
-
-	// required, err := ps.IsRequired()
-	// if err != nil {
-	// 	return nil, nil, err
-	// }
-
-	// if required {
-	// 	tagRequired = append(tagRequired, fieldName)
-	// }
-
-	// return map[string]*TypeSchema{fieldName: *schema}, tagRequired, nil
 }
 
 func getFieldType(field ast.Expr) (isArray bool, typeName string, err error) {