修改包路徑
This commit is contained in:
parent
bc4121c349
commit
c7bc870d05
128
README.md
128
README.md
@ -3,93 +3,103 @@
|
||||
### 1. 编译goctl-swagger插件
|
||||
|
||||
```
|
||||
$ GO111MODULE=on GOPROXY=https://goproxy.cn/,direct go get -u github.com/zeromicro/goctl-swagger
|
||||
GO111MODULE=on GOPROXY=https://goproxy.cn/,direct go get -u github.com/fachebot/goctl-swagger
|
||||
```
|
||||
|
||||
### 2. 配置环境
|
||||
|
||||
将$GOPATH/bin中的goctl-swagger添加到环境变量
|
||||
|
||||
### 3. 使用姿势
|
||||
|
||||
* 创建api文件
|
||||
|
||||
```go
|
||||
info(
|
||||
title: "type title here"
|
||||
desc: "type desc here"
|
||||
author: "type author here"
|
||||
email: "type email here"
|
||||
version: "type version here"
|
||||
title: "type title here"
|
||||
desc: "type desc here"
|
||||
author: "type author here"
|
||||
email: "type email here"
|
||||
version: "type version here"
|
||||
)
|
||||
|
||||
|
||||
type (
|
||||
RegisterReq {
|
||||
Username string `json:"username"`
|
||||
Password string `json:"password"`
|
||||
Mobile string `json:"mobile"`
|
||||
}
|
||||
|
||||
LoginReq {
|
||||
Username string `json:"username"`
|
||||
Password string `json:"password"`
|
||||
}
|
||||
|
||||
UserInfoReq {
|
||||
Id string `path:"id"`
|
||||
}
|
||||
|
||||
UserInfoReply {
|
||||
Name string `json:"name"`
|
||||
Age int `json:"age"`
|
||||
Birthday string `json:"birthday"`
|
||||
Description string `json:"description"`
|
||||
Tag []string `json:"tag"`
|
||||
}
|
||||
|
||||
UserSearchReq {
|
||||
KeyWord string `form:"keyWord"`
|
||||
}
|
||||
RegisterReq {
|
||||
Username string `json:"username"`
|
||||
Password string `json:"password"`
|
||||
Mobile string `json:"mobile"`
|
||||
}
|
||||
|
||||
LoginReq {
|
||||
Username string `json:"username"`
|
||||
Password string `json:"password"`
|
||||
}
|
||||
|
||||
UserInfoReq {
|
||||
Id string `path:"id"`
|
||||
}
|
||||
|
||||
UserInfoReply {
|
||||
Name string `json:"name"`
|
||||
Age int `json:"age"`
|
||||
Birthday string `json:"birthday"`
|
||||
Description string `json:"description"`
|
||||
Tag []string `json:"tag"`
|
||||
}
|
||||
|
||||
UserSearchReq {
|
||||
KeyWord string `form:"keyWord"`
|
||||
}
|
||||
)
|
||||
|
||||
service user-api {
|
||||
@doc(
|
||||
summary: "注册"
|
||||
)
|
||||
@handler register
|
||||
post /api/user/register (RegisterReq)
|
||||
|
||||
@doc(
|
||||
summary: "登录"
|
||||
)
|
||||
@handler login
|
||||
post /api/user/login (LoginReq)
|
||||
|
||||
@doc(
|
||||
summary: "获取用户信息"
|
||||
)
|
||||
@handler getUserInfo
|
||||
get /api/user/:id (UserInfoReq) returns (UserInfoReply)
|
||||
|
||||
@doc(
|
||||
summary: "用户搜索"
|
||||
)
|
||||
@handler searchUser
|
||||
get /api/user/search (UserSearchReq) returns (UserInfoReply)
|
||||
@doc(
|
||||
summary: "注册"
|
||||
)
|
||||
@handler register
|
||||
post /api/user/register (RegisterReq)
|
||||
|
||||
@doc(
|
||||
summary: "登录"
|
||||
)
|
||||
@handler login
|
||||
post /api/user/login (LoginReq)
|
||||
|
||||
@doc(
|
||||
summary: "获取用户信息"
|
||||
)
|
||||
@handler getUserInfo
|
||||
get /api/user/:id (UserInfoReq) returns (UserInfoReply)
|
||||
|
||||
@doc(
|
||||
summary: "用户搜索"
|
||||
)
|
||||
@handler searchUser
|
||||
get /api/user/search (UserSearchReq) returns (UserInfoReply)
|
||||
}
|
||||
```
|
||||
|
||||
* 生成swagger.json 文件
|
||||
|
||||
```shell script
|
||||
$ goctl api plugin -plugin goctl-swagger="swagger -filename user.json" -api user.api -dir .
|
||||
goctl api plugin -plugin goctl-swagger="swagger -filename user.json" -api user.api -dir .
|
||||
```
|
||||
|
||||
* 指定Host,basePath [api-host-and-base-path](https://swagger.io/docs/specification/2-0/api-host-and-base-path/)
|
||||
|
||||
```shell script
|
||||
$ goctl api plugin -plugin goctl-swagger="swagger -filename user.json -host 127.0.0.2 -basepath /api" -api user.api -dir .
|
||||
goctl api plugin -plugin goctl-swagger="swagger -filename user.json -host 127.0.0.2 -basepath /api" -api user.api -dir .
|
||||
```
|
||||
|
||||
* swagger ui 查看生成的文档
|
||||
|
||||
```shell script
|
||||
$ docker run --rm -p 8083:8080 -e SWAGGER_JSON=/foo/user.json -v $PWD:/foo swaggerapi/swagger-ui
|
||||
docker run --rm -p 8083:8080 -e SWAGGER_JSON=/foo/user.json -v $PWD:/foo swaggerapi/swagger-ui
|
||||
```
|
||||
|
||||
* Swagger Codegen 生成客户端调用代码(go,javascript,php)
|
||||
|
||||
```shell script
|
||||
for l in go javascript php; do
|
||||
docker run --rm -v "$(pwd):/go-work" swaggerapi/swagger-codegen-cli generate \
|
||||
@ -97,4 +107,4 @@ $ GO111MODULE=on GOPROXY=https://goproxy.cn/,direct go get -u github.com/zeromic
|
||||
-l "$l" \
|
||||
-o "/go-work/clients/$l"
|
||||
done
|
||||
```
|
||||
```
|
||||
|
@ -1,9 +1,9 @@
|
||||
package action
|
||||
|
||||
import (
|
||||
"github.com/fachebot/goctl-swagger/generate"
|
||||
"github.com/urfave/cli/v2"
|
||||
"github.com/zeromicro/go-zero/tools/goctl/plugin"
|
||||
"github.com/zeromicro/goctl-swagger/generate"
|
||||
)
|
||||
|
||||
func Generator(ctx *cli.Context) error {
|
||||
|
2
go.mod
2
go.mod
@ -1,4 +1,4 @@
|
||||
module github.com/zeromicro/goctl-swagger
|
||||
module github.com/fachebot/goctl-swagger
|
||||
|
||||
go 1.16
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user