如何在windows下使用swaggo

最新推荐文章于 2025-03-14 17:50:05 发布
原创 最新推荐文章于 2025-03-14 17:50:05 发布 · 3.7k 阅读 · 3 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#go #swaggo #swag

本文详细介绍了在Linux和Windows环境下安装Swag的步骤。Linux下通过goget命令进行安装，若$GOROOT/bin未加入$PATH，需手动移动swag至$GOBIN。Windows下因无bin目录，需定位swag下载位置并执行goinstall生成swag.exe。文章提供了验证安装成功的具体方法。

在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 -v
swag version v1.1.1

windows下的使用

windows下没有bin目录，首先我们需要找到swag的下载位置*…/github.com\swaggo\swag@v1.5.1\cmd\swag*
在该目录下执行go install 会生成swag.exe到gopath的主目录下。

这个swag.exe就可以用来执行swag init操作了。

win10下swagger editor安装
zsx18273117003的博客
07-05 1461
官方下载地址：https://github.com/swagger-api/swagger-editor 注：运行swagger editor必须安装node和npm，安装参考：win10下node.js安装 一、下载 二、解压 1. 解压文件到安装目录(C:\software\swagger-editor-master) 三、配置环境变量 四、运行服务 1....
使用 Swagger 在 Golang 中进行 API 文档生成
小小的木头人的博客
07-24 976
Swagger 是一款强大的 API 文档生成工具，可以帮助开发者轻松创建、管理和展示 RESTful API 文档。在本文中，我们将介绍如何在 Golang 项目中使用 Swagger 来生成 API 文档。
swag.exe windows golang
01-02
swagger 文档生成器
windows go环境安装 swag
赴前尘
12-31 1368
ps: 此时 $GOPATH\bin下出现了 swag.exe。ps: go env 获取 GOPATH位置。
go使用报错：swag : 无法将“swag”项识别为 cmdlet、函数、脚本文件或可运行程序的名称
weixin_52658189的博客
03-22 3764
这时候才想起之前为了部署go项目，把环境改成了Linux，再把环境改回来windows就可以了。后来网上查找解决办法是去gopath 的bin目录下看一下有没有swag.exe文件。检查go.mod发现swagger已经下载下来了。##go使用swagger的坑。发现确实没有swag.exe。在 执行这两句命令之后。
27-【go】windows下如何安装swag命令
qq_42303254的博客
01-11 5017
（1）安装swag命令： go get -u github.com/swaggo/swag/cmd/swag@v1.6.7 #会在gopath目录下的bin目录下生成swag.exe文件 （2）测试swag命令是否正常： swag init -g ./apiv1/swagger.go -o ./docs/swagger
Golang使用Gin框架整合Swagger生成api文档
reachyu的博客
05-28 1738
一、环境介绍二、开始整合1、安装swagger2、Gin router代码3、api代码4、生成api配置文档5、访问swagger 一、环境介绍 Go版本：1.13.1 开发工具：IntelliJ IDEA 2019.2.3 x64 开发环境：windows 10 64位 二、开始整合 代码目录结构 1、安装swagger IDEA Terminal 项目根目录执行 go get -u github.com/swaggo/swag/cmd/swag go get -u github.com/swagg.
go 安装swagger和Go依赖管理
A88552211的博客
03-14 747
go 安装swagger，以及报找不到命令如何处理
#!/bin/bash basepath=$(cd `dirname $0`; pwd) cd ${basepath}/go-src/go-web/ go mod tidy go get github.com/swaggo/swag/cmd/swag go install github.com/swaggo/swag/cmd/swag swag init cp -r ./docs ${basepath}/config/go/go-web/ allStep=5 nowStep=0 echo "编译完成第 $nowStep 步，共 $allStep 步" go mod tidy (go build -o ${basepath}/go/bin/go-web main.go ) || exit $? nowStep=$((nowStep+1)) echo "编译完成第 $nowStep 步，共 $allStep 步" cd ${basepath}/aiot_updater rm -rf .git* chmod +x ./build.sh (./build.sh ) || exit $? nowStep=$((nowStep+1)) echo "编译完成第 $nowStep 步，共 $allStep 步" # 用于配置服务 cd ${basepath}/go-src/go-system-config/ go mod tidy swag init mkdir -p ${basepath}/config/go/go-system-config/ cp -r ./docs ${basepath}/config/go/go-system-config/ cp -r ./config/application.yaml ${basepath}/config/go/go-system-config/ go mod tidy (go build -o ${basepath}/go/bin/go-system-config main.go ) || exit $? nowStep=$((nowStep+1)) echo "编译完成第 $nowStep 步，共 $allStep 步" # 用于监控服务 cd ${basepath}/go-src/go-monitoring/ go mod tidy swag init mkdir -p ${basepath}/config/go/go-monitoring/ cp -r ./docs ${basepath}/config/go/go-monitoring/ cp -r ./config/application.yaml ${basepath}/config/go/go-monitoring/ go mod tidy (go build -o ${basepath}/go/bin/go-monitoring main.go ) || exit $? nowStep=$((nowStep+1)) echo "编译完成第 $nowStep 步，共 $allStep 步" # 用于svg-service cd ${basepath}/go-src/svg-service/ # 定义源目录和目标目录 SOURCE_DIR="./resource/static" TARGET_DIR="$ECITYOS_ROOT/app/supaiot/static" TARGET2_DIR="$ECITYOS_ROOT/app/ecityos-iot/static" JS_SOURCE_DIR="$SOURCE_DIR/js" JS_TARGET_DIR="$TARGET_DIR/js" # 检查目标目录是否存在，如果不存在则创建 mkdir -p "$TARGET_DIR" # 复制除了js目录之外的所有文件和目录 cp -R "$SOURCE_DIR/css" "$TARGET_DIR" cp -R "$SOURCE_DIR/favicon.ico" "$TARGET_DIR" # 检查js源目录是否存在 if [ -d "$JS_SOURCE_DIR" ]; then # 确保目标js目录存在 mkdir -p "$JS_TARGET_DIR" cp "$JS_SOURCE_DIR"/*.jsx "$JS_TARGET_DIR/" # 遍历js目录下的所有js文件 for file in "$JS_SOURCE_DIR"/*.js; do # 提取文件名（不包括路径） filename=$(basename -- "$file") # 使用临时文件名来避免直接覆盖源文件时的潜在问题 tmp_file="$JS_SOURCE_DIR/.$filename.tmp" # 压缩js文件到临时文件 uglifyjs "$file" -o "$tmp_file" -m -c # 如果压缩成功，将临时文件重命名为原文件名（覆盖原文件） if [ $? -eq 0 ]; then mv "$tmp_file" "$file" # 将压缩后的文件复制到目标目录 cp "$file" "$JS_TARGET_DIR/" else echo "压缩文件 $file 失败，跳过。" fi done else echo "源目录中的js文件夹不存在，跳过js文件压缩和复制。" fi mkdir -p "$TARGET2_DIR" cp "$TARGET_DIR"/* "$TARGET2_DIR" go mod tidy (go build -o ${basepath}/go/bin/svg-service main.go ) || exit $? nowStep=$((nowStep+1)) echo "编译完成第 $nowStep 步，共 $allStep 步" 把这个shell脚本修改成windows的minGW和Linux 都适用的版本
最新发布
03-20
2. **路径处理**：在Windows下需要特别小心反斜杠 (`\`) 和正斜杠 (`/`) 的区别，在某些场景需将其标准化为 `/` 格式。 3. **外部程序依赖**：例如 `uglifyjs` 工具是否可以在 Windows 下正常运行也需要确认。 以下...
Go语言RESTful API开发工具：推荐与使用技巧
![Go语言RESTful API开发工具：推荐与使用技巧]...Go语言，作为一种静态类型、编译型语言，因其简洁、高效、快速的特性，在构建高性能网络应用方面表现优异。本章将为读者简要
golang windows环境下集成swag的步骤
fang0604631023的博客
05-24 945
golang windows环境下集成swag的步骤
Windows 搭建swagger editor 和swagger ui
u013796473的博客
07-12 3667
一，搭建swagger editor 要求：node.js环境 1，安装node.js 2, npm install; 3, git clone https://github.com/swagger-api/swagger-editor.git cd swagger-editor npm install npm run build npm start 4，然后就根据网址启动swag
Swagger Windows 本地安装搭建
飞哥的程序员生活日常
12-22 1853
一、创建环境 需要单独的创建文件，以免和其他文件出现冲突， 二、拉取项目 将两个项目文件拉取下来，然后利用composert 安装 swagger-php 的依赖， 其中swagger-ui 是前端渲染项目，swagger-php是用于抓取你项目注释的工具 国内网络的问题，这是在码云的地址，速度快 swagger-ui:https://gitee.com/adk/swagger-ui.git swagger-php:https://gitee.com/techdoge/swagger-..
swag init不是内部或外部命令
weixin_45894608的博客
04-25 696
swag init不是内部或外部命令。简单明了，直接了当
【swag】安装 swag 后，找不到 swag.exe
这里主要记录一些学到的新知识
08-15 1824
在项目中成功 go get 安装 swag 的代码后，检查 swag 版本时输入 swag -v 提示 swag 不是内部或外部命令，也不是可运行的程序。进一步检查 GOPATH\bin 目录，没有找到 swag.exe 文件，所以 swag -v 不起作用。
使用swag init --parseDependency生成api文档报错解决办法
zhoupenghui168的博客
09-29 818
golang使用swag生成api文档报错解决办法
【swaggo】swaggo使用详解
SauryN的博客
12-26 7091
go 使用swagger工具swaggo，与gin集成
Windows下部署Swagger Edit、Swagger UI
Mr_xiaozhou的博客
06-28 4420
Windows下部署Swagger Edit、Swagger UI）一、环境需求——已安装node环境二、准备Swagger Editor、Swagger UI源码三、搭建Swagger Editor四、搭建Swagger UI五、Swagger UI 的简单使用 一、环境需求——已安装node环境 可以参考我的另一篇文章Windows下安装nodejs 二、准备Swagger Editor、Sw...
swaggo CollectionFormat
12-10
Swaggo 是一个用于生成 Swagger 文档的工具，而 CollectionFormat 是 Swagger 中用于描述参数集合格式的一个属性。CollectionFormat 主要用于定义多个值如何组合成一个参数的情况，常见于查询参数和路径参数。以下是几种常见的 CollectionFormat： 1. **csv**：逗号分隔的值，例如 `?ids=1,2,3`。 2. **ssv**：空格分隔的值，例如 `?ids=1%202%203`。 3. **tsv**：制表符分隔的值，例如 `?ids=1%092%093`。 4. **pipes**：管道符分隔的值，例如 `?ids=1|2|3`。 5. **multi**：多个相同名称的参数，例如 `?ids=1&ids=2&ids=3`。 在 swaggo 中，你可以通过在注释中指定 `collectionFormat` 来定义参数的集合格式。例如： ```go // @Param ids query []int true "IDs" collectionFormat(csv) func GetItemsByIDs(c *gin.Context) { // 处理逻辑 } ``` 在这个例子中，`ids` 参数是一个整数数组，使用逗号分隔的格式传递。
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值