feat: rename apidocgen

alovn · alovn · commit 313ee519cf11 · 2022-05-17T18:40:11.000+08:00
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -10,7 +10,7 @@
             "request": "launch",
             "mode": "debug",
             "cwd": "${workspaceRoot}",
-            "program": "${workspaceFolder}/cmd/apidoc/main.go",
+            "program": "${workspaceFolder}/main.go",
             "args": [
                 "--dir", "examples/svc-user,examples/common",
                 "--output", "examples/docs",
diff --git a/README.md b/README.md
@@ -1 +1,28 @@
-# apidoc
+# apidocgen
+
+apidocgen is a tool for Go to generate apis markdown docs.
+
+## Install
+
+```bash
+go install github.com/alovn/apidocgen/@latest
+```
+
+## Usage
+
+```bash
+$ apidocgen --help
+apidocgen is a tool for Go to generate apis markdown docs.
+
+Usage:
+  apidocgen --dir= --excludes= --output= --template= --single
+
+Flags:
+    --dir:       Search apis dir, comma separated, default .
+    --excludes:  Exclude directories and files when searching, comma separated
+    --output:    Generate markdown files dir, default ./docs/
+    --template:  Custom template files dir.
+    --single:    If true, generate a single markdown file, default false
+```
+
+run the command in the go module directory.
diff --git a/examples/docs/apis-account.md b/examples/docs/apis-account.md
@@ -20,7 +20,7 @@ POST /user/account/register
 __Request__:
 
 parameter|parameterType|dataType|required|validate|example|description
---|--|--|--|--|--|--
+--|:-:|:-:|:-:|--|--|--
 __from__|_query_|string|false|||test
 __password__|_form_|string|true|required||密码
 __username__|_form_|string|true|required||用户名
@@ -71,7 +71,7 @@ POST /user/account/login
 __Request__:
 
 parameter|parameterType|dataType|required|validate|example|description
---|--|--|--|--|--|--
+--|:-:|:-:|:-:|--|--|--
 __password__|_form_|string|true|required||登录密码
 __username__|_form_|string|true|required||登录用户名
 __validate_code__|_form_|string|false|||验证码
diff --git a/examples/docs/apis-address.md b/examples/docs/apis-address.md
@@ -21,7 +21,7 @@ POST /user/address/create
 __Request__:
 
 parameter|parameterType|dataType|required|validate|example|description
---|--|--|--|--|--|--
+--|:-:|:-:|:-:|--|--|--
 __address__|_form_|string|true|required||地址
 __city_id__|_form_|int64|true|required||城市ID
 
@@ -57,7 +57,7 @@ POST /user/address/update
 __Request__:
 
 parameter|parameterType|dataType|required|validate|example|description
---|--|--|--|--|--|--
+--|:-:|:-:|:-:|--|--|--
 __address__|_form_|string|true|required||地址
 __id__|_form_|int64|true|required||地址ID
 
@@ -84,7 +84,7 @@ POST /user/address/delete
 __Request__:
 
 parameter|parameterType|dataType|required|validate|example|description
---|--|--|--|--|--|--
+--|:-:|:-:|:-:|--|--|--
 __id__|_form_|int64|true|required||地址ID
 
 __Response__:
@@ -110,7 +110,7 @@ GET /user/address/get/:id
 __Request__:
 
 parameter|parameterType|dataType|required|validate|example|description
---|--|--|--|--|--|--
+--|:-:|:-:|:-:|--|--|--
 __id__|_param_|int64|false|||地址ID
 
 __Response__:
diff --git a/examples/docs/apis-demo.md b/examples/docs/apis-demo.md
@@ -150,7 +150,7 @@ GET /user/demo/xml
 __Request__:
 
 parameter|parameterType|dataType|required|validate|example|description
---|--|--|--|--|--|--
+--|:-:|:-:|:-:|--|--|--
 __id__|_param_|int64|false|||DemoID
 
 _body_:
diff --git a/examples/svc-greeter/main.go b/examples/svc-greeter/main.go
@@ -5,7 +5,7 @@ import (
 	"fmt"
 	"time"
 
-	"github.com/alovn/apidoc/examples/common"
+	"github.com/alovn/apidocgen/examples/common"
 )
 
 //@title greeter服务
diff --git a/examples/svc-user/handler/account.go b/examples/svc-user/handler/account.go
@@ -4,7 +4,7 @@ import (
 	"encoding/json"
 	"net/http"
 
-	"github.com/alovn/apidoc/examples/common"
+	"github.com/alovn/apidocgen/examples/common"
 )
 
 type AccountHandler struct {
diff --git a/examples/svc-user/handler/address.go b/examples/svc-user/handler/address.go
@@ -4,7 +4,7 @@ import (
 	"encoding/json"
 	"net/http"
 
-	"github.com/alovn/apidoc/examples/common"
+	"github.com/alovn/apidocgen/examples/common"
 )
 
 type AddressHandler struct {
diff --git a/examples/svc-user/handler/demo.go b/examples/svc-user/handler/demo.go
@@ -6,7 +6,7 @@ import (
 	"net/http"
 	"time"
 
-	"github.com/alovn/apidoc/examples/common"
+	"github.com/alovn/apidocgen/examples/common"
 )
 
 type DemoHandler struct{}
diff --git a/examples/svc-user/handler/menu.go b/examples/svc-user/handler/menu.go
@@ -4,7 +4,7 @@ import (
 	"encoding/json"
 	"net/http"
 
-	"github.com/alovn/apidoc/examples/common"
+	"github.com/alovn/apidocgen/examples/common"
 )
 
 type MenuHandler struct{}
diff --git a/examples/svc-user/main.go b/examples/svc-user/main.go
@@ -3,7 +3,7 @@ package main
 import (
 	"net/http"
 
-	"github.com/alovn/apidoc/examples/svc-user/handler"
+	"github.com/alovn/apidocgen/examples/svc-user/handler"
 )
 
 //@title 用户服务
diff --git a/gen/gen.go b/gen/gen.go
@@ -11,7 +11,7 @@ import (
 	"strings"
 	"text/template"
 
-	"github.com/alovn/apidoc"
+	"github.com/alovn/apidocgen/parser"
 )
 
 type Gen struct {
@@ -30,7 +30,7 @@ type Config struct {
 	SearchDir       string
 	OutputDir       string
 	TemplateDir     string
-	Excludes        string
+	ExcludesDir     string
 	IsGenSingleFile bool
 }
 
@@ -78,12 +78,12 @@ func (g *Gen) Build() error {
 	if g.templateFS == nil && g.c.TemplateDir != "" {
 		g.templateFS = os.DirFS(g.c.TemplateDir)
 	}
-	var templateSingle string
+	var templateSingleIndex string
 	var templateGroupIndex string
 	var templateGroupApis string
 	var templateConfig TemplateConfig
 
-	if templateSingle, err = g.readTemplate("single.tpl"); err != nil {
+	if templateSingleIndex, err = g.readTemplate("single_index.tpl"); err != nil {
 		return err
 	}
 	if templateGroupIndex, err = g.readTemplate("group_index.tpl"); err != nil {
@@ -104,8 +104,8 @@ func (g *Gen) Build() error {
 		fmt.Println("use template:", templateConfig.Name)
 	}
 
-	p := apidoc.New()
-	apidoc.SetExcludedDirsAndFiles(g.c.Excludes)(p)
+	p := parser.New()
+	parser.SetExcludedDirsAndFiles(g.c.ExcludesDir)(p)
 	if err := p.Parse(searchDirs); err != nil {
 		return err
 	}
@@ -124,7 +124,7 @@ func (g *Gen) Build() error {
 	}
 
 	if len(doc.UngroupedApis) > 0 {
-		doc.Groups = append(doc.Groups, &apidoc.ApiGroupSpec{
+		doc.Groups = append(doc.Groups, &parser.ApiGroupSpec{
 			Group:       "ungrouped",
 			Title:       "ungrouped",
 			Description: "Ungrouped apis",
@@ -149,16 +149,16 @@ func (g *Gen) Build() error {
 			return a + b
 		},
 	}
-	sortApis := func(apis []*apidoc.ApiSpec) {
+	sortApis := func(apis []*parser.ApiSpec) {
 		less := func(i, j int) bool {
 			a, b := apis[i], apis[j]
 			return a.Order < b.Order
 		}
 		sort.Slice(apis, less)
 	}
 	if g.c.IsGenSingleFile {
-		t := template.New("apis-single").Funcs(funcMap)
-		t, err := t.Parse(templateSingle)
+		t := template.New("single-index").Funcs(funcMap)
+		t, err := t.Parse(templateSingleIndex)
 		if err != nil {
 			return err
 		}
diff --git a/gen/template/group_apis.tpl b/gen/template/group_apis.tpl
@@ -40,7 +40,7 @@ version: _{{$v.Version}}_
 __Request__:
 
 parameter|parameterType|dataType|required|validate|example|description
---|--|--|--|--|--|--
+--|:-:|:-:|:-:|--|--|--
 {{- range $p:= $v.Requests.Parameters}}
 __{{$p.Name}}__|_{{$p.ParameterTypes}}_|{{$p.DataType}}|{{$p.Required}}|{{$p.Validate}}|{{$p.Example}}|{{$p.Description}}
 {{- end}}
diff --git a/gen/template/single_index.tpl b/gen/template/single_index.tpl
@@ -50,7 +50,7 @@ version: _{{$v.Version}}_
 __Request__:
 
 parameter|parameterType|dataType|required|validate|example|description
---|--|--|--|--|--|--
+--|:-:|:-:|:-:|--|--|--
 {{- range $p:= $v.Requests.Parameters}}
 __{{$p.Name}}__|_{{$p.ParameterTypes}}_|{{$p.DataType}}|{{$p.Required}}|{{$p.Validate}}|{{$p.Example}}|{{$p.Description}}
 {{- end}}
diff --git a/go.mod b/go.mod
@@ -1,4 +1,4 @@
-module github.com/alovn/apidoc
+module github.com/alovn/apidocgen
 
 go 1.17
 
diff --git a/main.go b/main.go
@@ -5,7 +5,7 @@ import (
 	"fmt"
 	"log"
 
-	"github.com/alovn/apidoc/gen"
+	"github.com/alovn/apidocgen/gen"
 )
 
 func main() {
@@ -23,24 +23,24 @@ func main() {
 	flag.BoolVar(&isHelp, "help", false, "--help")
 	flag.Parse()
 	if isHelp {
-		fmt.Println(`apidoc is a tool for Go to generate apis markdown docs.
+		fmt.Println(`apidocgen is a tool for Go to generate apis markdown docs.
 
 Usage:
-  apidoc --dir= --output= --template= --single
+  apidocgen --dir= --excludes= --output= --template= --single
 
 Flags:
 	--dir:		Search apis dir, comma separated, default .
 	--excludes:	Exclude directories and files when searching, comma separated
 	--output: 	Generate markdown files dir, default ./docs/
-	--template: Custom template files dir.
+	--template:	Custom template files dir.
 	--single: 	If true, generate a single markdown file, default false`)
 		return
 	}
 	g := gen.New(&gen.Config{
 		SearchDir:       searchDir,
 		OutputDir:       outputDir,
 		TemplateDir:     templateDir,
-		Excludes:        excludesDir,
+		ExcludesDir:     excludesDir,
 		IsGenSingleFile: isSingle,
 	})
 	if err := g.Build(); err != nil {
diff --git a/parser/operation.go b/parser/operation.go
@@ -1,4 +1,4 @@
-package apidoc
+package parser
 
 import (
 	"fmt"
@@ -243,21 +243,10 @@ func (operation *Operation) parseObject(refType string, astFile *ast.File) (*Typ
 		}, nil
 	}
 	switch {
-	// case IsGolangPrimitiveType(refType):
-	// 	return &TypeSchema{
-	// 		Name:     refType,
-	// 		Type:     refType,
-	// 		FullName: refType,
-	// 	}, nil
 	case strings.Contains(refType, "{"):
 		return operation.parseCombinedObject(refType, astFile)
 	default:
-		schema, err := operation.parser.getTypeSchema(refType, astFile, nil)
-		if err != nil {
-			return nil, err
-		}
-
-		return schema, nil
+		return operation.parser.getTypeSchema(refType, astFile, nil)
 	}
 }
 
diff --git a/parser/operation_test.go b/parser/operation_test.go
@@ -1,4 +1,4 @@
-package apidoc
+package parser
 
 import (
 	"testing"
diff --git a/parser/packages.go b/parser/packages.go
@@ -1,4 +1,4 @@
-package apidoc
+package parser
 
 import (
 	"go/ast"
diff --git a/parser/parser.go b/parser/parser.go
diff --git a/parser/schema.go b/parser/schema.go
diff --git a/parser/spec.go b/parser/spec.go
diff --git a/parser/types.go b/parser/types.go

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ import (`
`5`	`5`	`"fmt"`
`6`	`6`	`"time"`
`7`	`7`
`8`		`- "github.com/alovn/apidoc/examples/common"`
	`8`	`+ "github.com/alovn/apidocgen/examples/common"`
`9`	`9`	`)`
`10`	`10`
`11`	`11`	`//@title greeter服务`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ import (`
`4`	`4`	`"encoding/json"`
`5`	`5`	`"net/http"`
`6`	`6`
`7`		`- "github.com/alovn/apidoc/examples/common"`
	`7`	`+ "github.com/alovn/apidocgen/examples/common"`
`8`	`8`	`)`
`9`	`9`
`10`	`10`	`type AccountHandler struct {`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ import (`
`6`	`6`	`"net/http"`
`7`	`7`	`"time"`
`8`	`8`
`9`		`- "github.com/alovn/apidoc/examples/common"`
	`9`	`+ "github.com/alovn/apidocgen/examples/common"`
`10`	`10`	`)`
`11`	`11`
`12`	`12`	`type DemoHandler struct{}`