修改包路徑

This commit is contained in:
fachebot 2022-03-24 19:20:24 +08:00
parent bc4121c349
commit c7bc870d05
4 changed files with 72 additions and 62 deletions

View File

@ -3,15 +3,17 @@
### 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"
@ -77,19 +79,27 @@ $ GO111MODULE=on GOPROXY=https://goproxy.cn/,direct go get -u github.com/zeromic
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 .
```
* 指定HostbasePath [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 \

View File

@ -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
View File

@ -1,4 +1,4 @@
module github.com/zeromicro/goctl-swagger
module github.com/fachebot/goctl-swagger
go 1.16

View File

@ -5,8 +5,8 @@ import (
"os"
"runtime"
"github.com/fachebot/goctl-swagger/action"
"github.com/urfave/cli/v2"
"github.com/zeromicro/goctl-swagger/action"
)
var (