docs: update goctl markdown (#1370)

master
Kevin Wan 3 years ago committed by GitHub
parent c0647f0719
commit 1d223fc114
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -11,7 +11,7 @@
### goctl 参数说明 ### goctl 参数说明
`goctl api [go/java/ts] [-api user/user.api] [-dir ./src]` `goctl api [go/java/ts] [-api user/user.api] [-dir ./src]`
> api 后面接生成的语言现支持go/java/typescript > api 后面接生成的语言现支持go/java/typescript
> >
> -api 自定义api所在路径 > -api 自定义api所在路径
@ -140,51 +140,49 @@ service user-api {
`goctl api go -api user/user.api -dir user` `goctl api go -api user/user.api -dir user`
```Plain Text ```Plain Text
.
. ├── internal
├── internal │   ├── config
│   ├── config │   │   └── config.go
│   │   └── config.go │   ├── handler
│   ├── handler │   │   ├── pinghandler.go
│   │   ├── pinghandler.go │   │   ├── profile
│   │   ├── profile │   │   │   ├── createprofilehandler.go
│   │   │   ├── createprofilehandler.go │   │   │   └── getprofilehandler.go
│   │   │   └── getprofilehandler.go │   │   ├── routes.go
│   │   ├── routes.go │   │   └── user
│   │   └── user │   │   ├── createuserhandler.go
│   │   ├── createuserhandler.go │   │   └── getuserhandler.go
│   │   └── getuserhandler.go │   ├── logic
│   ├── logic │   │   ├── pinglogic.go
│   │   ├── pinglogic.go │   │   ├── profile
│   │   ├── profile │   │   │   ├── createprofilelogic.go
│   │   │   ├── createprofilelogic.go │   │   │   └── getprofilelogic.go
│   │   │   └── getprofilelogic.go │   │   └── user
│   │   └── user │   │   ├── createuserlogic.go
│   │   ├── createuserlogic.go │   │   └── getuserlogic.go
│   │   └── getuserlogic.go │   ├── svc
│   ├── svc │   │   └── servicecontext.go
│   │   └── servicecontext.go │   └── types
│   └── types │   └── types.go
│   └── types.go └── user.go
└── user.go
``` ```
生成的代码可以直接跑,有几个地方需要改: 生成的代码可以直接跑,有几个地方需要改:
* 在`servicecontext.go`里面增加需要传递给logic的一些资源比如mysql, redisrpc等 * 在`servicecontext.go`里面增加需要传递给logic的一些资源比如mysql, redisrpc等
* 在定义的get/post/put/delete等请求的handler和logic里增加处理业务逻辑的代码 * 在定义的get/post/put/delete等请求的handler和logic里增加处理业务逻辑的代码
#### 根据定义好的api文件生成java代码 #### 根据定义好的api文件生成java代码
```Plain Text ```Plain Text
goctl api java -api user/user.api -dir ./src goctl api java -api user/user.api -dir ./src
``` ```
#### 根据定义好的api文件生成typescript代码 #### 根据定义好的api文件生成typescript代码
```Plain Text ```Plain Text
goctl api ts -api user/user.api -dir ./src -webapi *** goctl api ts -api user/user.api -dir ./src -webapi ***
``` ```
ts需要指定webapi所在目录 ts需要指定webapi所在目录
@ -192,5 +190,5 @@ ts需要指定webapi所在目录
#### 根据定义好的api文件生成Dart代码 #### 根据定义好的api文件生成Dart代码
```Plain Text ```Plain Text
goctl api dart -api user/user.api -dir ./src goctl api dart -api user/user.api -dir ./src
``` ```

Loading…
Cancel
Save