update Readme

lovego · Jul 12, 2020 · 085f1e0 · 085f1e0
1 parent a51a01c
commit 085f1e0
Show file tree

Hide file tree

Showing 10 changed files with 75 additions and 2 deletions.
diff --git a/Readme.md b/Readme.md
@@ -1,11 +1,14 @@
 # goa
-a golang http router with regexp support, inspired by `httprouter` and `gin`.
+a golang http router with regexp support and document generation.
 
 [![Build Status](https://travis-ci.org/lovego/goa.svg?branch=master)](https://travis-ci.org/lovego/goa)
 [![Coverage Status](https://img.shields.io/coveralls/github/lovego/goa/master.svg)](https://coveralls.io/github/lovego/goa?branch=master)
 [![Go Report Card](https://goreportcard.com/badge/github.com/lovego/goa?1)](https://goreportcard.com/report/github.com/lovego/goa)
 [![GoDoc](https://godoc.org/github.com/lovego/goa?status.svg)](https://godoc.org/github.com/lovego/goa)
 
+## document generation
+see [example](docs/z_test.go) and [the generated documents](docs/testdata/README.md).
+
 ## default middlewares
 - logging with error alarm support
 - list of requests in processing

diff --git a/docs/.gitignore b/docs/.gitignore
diff --git a/docs/testdata/README.md b/docs/testdata/README.md
@@ -0,0 +1,6 @@
+## 账号
+### 　[用户 (/users)](users/README.md)
+### 　[公司 (/companies)](companies/README.md)
+## [商品 (/goods)](goods/README.md)
+## [单据 (/bill)](bill/README.md)
+## [库存 (/storage)](storage/README.md)
diff --git a/docs/testdata/bill/README.md b/docs/testdata/bill/README.md
@@ -0,0 +1,3 @@
+# 单据 (/bill)
+采购、销售
+
diff --git a/docs/testdata/companies/README.md b/docs/testdata/companies/README.md
@@ -0,0 +1 @@
+# 公司 (/companies)
diff --git a/docs/testdata/goods/README.md b/docs/testdata/goods/README.md
@@ -0,0 +1 @@
+# 商品 (/goods)
diff --git a/docs/testdata/storage/README.md b/docs/testdata/storage/README.md
@@ -0,0 +1 @@
+# 库存 (/storage)
diff --git a/docs/testdata/users/(?P<type>\w+)/GET_(?P<id>\d+).md b/docs/testdata/users/(?P<type>\w+)/GET_(?P<id>\d+).md
@@ -0,0 +1,21 @@
+# 用户详情 ： GET /users/(?P&lt;type&gt;\w+)/(?P&lt;id&gt;\d+)
+获取用户的详细信息
+
+## 路径中正则参数（子表达式）说明
+- type (string): 类型
+- id (int): ID
+
+## 返回头说明
+- Set-Cookie: 返回登录会话
+
+## 返回体说明（application/json）
+```json5
+{
+  "code": "",	 # ok表示成功，其他表示错误代码
+  "message": "",	 # 与code对应的描述信息
+  "data": {	 # 返回的数据
+    "Id": 0,	 # ID
+    "Name": ""	 # 名称
+  }
+}
+```
diff --git a/docs/testdata/users/GET.md b/docs/testdata/users/GET.md
@@ -0,0 +1,35 @@
+# 用户列表 ： GET /users
+列出所有的用户
+
+## Query参数说明
+- page (int): 页码
+- type (string): 类型
+- id (int): ID
+- flag (bool): 标志
+
+## 请求头说明
+- Cookie (string): Cookie中包含会话信息
+
+## 请求体说明（application/json）
+```json5
+{
+  "Name": "",	 # 名称
+  "Type": "",	 # 类型
+  "Id": 0,	 # ID
+  "Flag": false	 # 标志
+}
+```
+
+## 返回体说明（application/json）
+```json5
+{
+  "code": "",	 # ok表示成功，其他表示错误代码
+  "message": "",	 # 与code对应的描述信息
+  "data": [	 # 返回的数据
+    {
+      "Id": 0,	 # ID
+      "Name": ""	 # 名称
+    }
+  ]
+}
+```
diff --git a/docs/testdata/users/README.md b/docs/testdata/users/README.md
@@ -0,0 +1,3 @@
+# 用户 (/users)
+### 　[用户列表 ： GET /users](GET.md)
+### 　[用户详情 ： GET /users/(?P&lt;type&gt;\w+)/(?P&lt;id&gt;\d+)](%28%3FP%3Ctype%3E%5Cw+%29/GET_%28%3FP%3Cid%3E%5Cd+%29.md)