windows下没有bin目录,首先我们需要找到swag的下载位置*…/github.com\swaggo\swag@v1.5.1\cmd\swag*
在该目录下执行go install 会生成swag.exe到gopath的主目录下。
这个swag.exe就可以用来执行swag init操作了。
在Linux下安装的流程$ go get -u github.com/swaggo/swag/cmd/swag若 $GOROOT/bin 没有加入$PATH中,你需要执行将其可执行文件移动到$GOBIN下mv $GOPATH/bin/swag /usr/local/go/bin验证是否安装成功检查 $GOBIN 下是否有 swag 文件,如下:$ swag -vswag v...
文章目录go实践之
swag
ger自动生成api文档1、安装需要用到的包2、接口代码支持
swag
ger3、 生成
swag
ger接口
go实践之
swag
ger自动生成api文档
作为一个后端开发,给前端提供api接口是必须的。手动去写文档不是一个程序员的风格。
swag
ger就是一个很好的api文档生成该工具,go当然也支持了。下面看看怎么
使用
这个工具。
1、安装需要用到的包
root@localhos...
1.下载 nodejs,并安装
2. 下载
swag
ger editor并安装
2.1 git clone https://github.com/
swag
ger-api/
swag
ger-editor.git //从github下载
swag
ger-editor
2.2 cd
swag
ger-editor //进入到下载的文件夹中
2.3 npm install
将两个项目文件拉取下来,然后利用composert 安装
swag
ger-php 的依赖,
其中
swag
ger-ui 是前端渲染项目,
swag
ger-php是用于抓取你项目注释的工具
国内网络的问题,这是在码云的地址,速度快
swag
ger-ui:https://gitee.com/adk/
swag
ger-ui.git
swag
ger-php:https://gitee.com/techdoge/
swag
ger-..
swag
ger_
windows
_amd64.exe
将
swag
ger_
windows
_amd64.exe 重命名 成
swag
ger.exe
然后将该软件放到D:\bin 中
然后再操作系统的PATH 中添加 D:\bin
2.2 linux
swag
ger_l...
Windows
下部署
Swag
ger Edit、
Swag
ger UI)一、环境需求——已安装node环境二、准备
Swag
ger Editor、
Swag
ger UI源码三、搭建
Swag
ger Editor四、搭建
Swag
ger UI五、
Swag
ger UI 的简单
使用
一、环境需求——已安装node环境
可以参考我的另一篇文章
Windows
下安装nodejs
二、准备
Swag
ger Editor、
Sw
...
[toc]
Java
使用
Spring Boot写Restful API时,可以在代码里用注解来标识API,编译为Jar包后,运行时Web应用可以直接托管API文档。具体的可以参考文章:
使用
swag
ger来做API文档。
那么golang系有没有类似的做法呢?
有是有的,只是没有springfox的那么方便就是了。
swag
go提供了golang版本的
swag
ger自动生产Restful API文档...
swag
go/
swag
提供了Go版本的
Swag
ger自动生产RESTful API文档,其做法是在代码中按
Swag
go的格式编写API注释,然后
Swag
go会去解析这些注释,生成
Swag
ger的文档以及托管到Web的框架代码,最终将代码编译到Web应用中,达到API文档托管的目的。
go-
swag
ger是一套完整且功能齐全的高性能API组件,可与
Swag
ger-API一起
使用
,分为三块分别是服务...
有时候修改完
swag
之后,没有重新执行 go run main.go,直接刷新
swag
.index页面,页面并不会发生变化,按正常操作顺序,我们应该:
1.在项目目录下运行
swag
init
2.运行 go run main.go
今天,偶然发现 go语言中 exec.Command 方法可以在当前目录运行系统命令,所以我们就可以在main方法执行的第一行,先执行一个exec.Command,
例子如下:
func runCommand() {
cmd := exec.Command("
swag
Go学习笔记(六) |
使用
swag
go自动生成Restful API文档
Mac下安装
swag
go
本文是在mac环境下,但是方法在
windows
下是相通的,因为都是基于goland的终端进行的操作,如果是在系统终端下也是ok的。
在写代码时也是要写明注释的,而写完api接口之后,肯定也是要对外提供api文档,这样别人才能够准确
使用
你的借口,而好的接口文档可以为你后期减少很多不必要的沟通问题。
再者,在开发api阶段你肯定也是要自己验证api的结果的,而s
为gin项目增加
swag
ger能力,方便管理api
按照官方文档进行 https://github.com/
swag
go/
swag
/blob/master/README_zh-CN.md
//安装
swag
go install github.com/
swag
go/
swag
/cmd/
swag
@latest
//查看
swag
版本
swag
-v
1.7.9
//初始化
swag
init
初始化后发现在doc中是这样的:
var
Swag
gerInfo_
swag
ger = &
swag