update doc (#64)

* rebase upstream

* rebase

* trim no need line

* trim no need line

* trim no need line

* update doc

* update doc

* remove update

Co-authored-by: kingxt <dream4kingxt@163.com>
This commit is contained in:
kingxt
2020-09-11 16:16:30 +08:00
committed by GitHub
parent 754e631dc4
commit e1d942a799
2 changed files with 5 additions and 9 deletions

View File

@@ -22,17 +22,10 @@
> -dir 自定义生成目录
#### 保持goctl总是最新版
第一次运行会在~/.goctl里增加下面两行
```
url = http://47.97.184.41:7777/
```
#### API 语法说明
```
``` golang
info(
title: doc title
desc: >
@@ -128,7 +121,9 @@ service user-api {
)
head /api/ping()
}
```
1. info部分描述了api基本信息比如Authapi是哪个用途。
2. type部分type类型声明和golang语法兼容。
3. service部分service代表一组服务一个服务可以由多组名称相同的service组成可以针对每一组service配置jwt和auth认证另外通过folder属性可以指定service生成所在子目录。