go-zero 接入 swagger

##背景

因为不想频繁的改接口

下拉代码

PS D:\myself\Golang\common_project\src\jiuyou> git clone https://github.com/zeromicro/goctl-swagger.git
Cloning into 'goctl-swagger'...
remote: Enumerating objects: 404, done.
remote: Counting objects: 100% (137/137), done.
remote: Compressing objects: 100% (72/72), done.
remote: Total 404 (delta 91), reused 84 (delta 65), pack-reused 267
Receiving objects: 100% (404/404), 8.50 MiB | 871.00 KiB/s, done.
Resolving deltas: 100% (209/209), done.
PS D:\myself\Golang\common_project\src\jiuyou> 

进入项目

PS D:\myself\Golang\common_project\src\jiuyou> cd .\goctl-swagger\
PS D:\myself\Golang\common_project\src\jiuyou\goctl-swagger> pwd

Path
----
D:\myself\Golang\common_project\src\jiuyou\goctl-swagger


PS D:\myself\Golang\common_project\src\jiuyou\goctl-swagger>

执行脚本

1

goctl api plugin -plugin D:\myself\Golang\common_project\src\jiuyou\goctl-swagger\main.exe="swagger --filename swagger.json" -api api/desc/om.api -dir .

2

goctl api plugin -plugin D:\myself\Golang\common_project\src\jiuyou\goctl-swagger\main.exe="swagger -filename swagger.json -host 127.0.0.2 -basepath /api" -api api/desc/om.api -dir .

3.跑项目

docker run --rm -p 8083:8080 -e SWAGGER_JSON=/om-api/swagger.json -v D:\myself\Golang\common_project\src\jiuyou\om-api:/om-api swaggerapi/swagger-ui

报错的命令

识别不了$PWD 建议使用上面的

docker run --rm -p 8083:8080 -e SWAGGER_JSON=/om-api/swagger.json -v $PWD:/om-api swaggerapi/swagger-ui

执行结果如下

D:\myself\Golang\common_project\src\jiuyou\om-api>docker run --rm -p 8083:8080 -e SWAGGER_JSON=/om-api/swagger.json -v D:\myself\Golang\common_project\src\jiuyou\om-api:/om-api swaggerapi/swagger-ui
/docker-entrypoint.sh: /docker-entrypoint.d/ is not empty, will attempt to perform configuration
/docker-entrypoint.sh: Looking for shell scripts in /docker-entrypoint.d/
/docker-entrypoint.sh: Launching /docker-entrypoint.d/10-listen-on-ipv6-by-default.sh
10-listen-on-ipv6-by-default.sh: info: Getting the checksum of /etc/nginx/conf.d/default.conf
10-listen-on-ipv6-by-default.sh: info: Enabled listen on IPv6 in /etc/nginx/conf.d/default.conf
/docker-entrypoint.sh: Launching /docker-entrypoint.d/20-envsubst-on-templates.sh
/docker-entrypoint.sh: Launching /docker-entrypoint.d/30-tune-worker-processes.sh
/docker-entrypoint.sh: Launching /docker-entrypoint.d/40-swagger-ui.sh
/docker-entrypoint.sh: Configuration complete; ready for start up

看看界面

本作品采用《CC 协议》，转载必须注明作者和本文链接