在Windows上安装swaggo（swagger + gin）

Question

我正在尝试在 Windows 上为 gin-gonic 设置 swagger。 swaggo 的文档指出我应该运行：

go get -u github.com/swaggo/swag/cmd/swag

安装后，我应该能够从我有

swag init

的项目根目录中运行

main.go

，但 cmdlet 声明如下：

swag : The term 'swag' is not recognized as the name of a cmdlet, function, script file, or operable program. Check
the spelling of the name, or if a path was included, verify that the path is    correct and try again.
At line:1 char:1
+ swag
+ ~~~~
+ CategoryInfo          : ObjectNotFound: (swag:String) [],  CommandNotFoundException
+ FullyQualifiedErrorId : CommandNotFoundException

如何将 swag 添加到 PATH 或者我应该如何从这里继续？

Ps，我遵循了here

的文档

更新：所以我在另一台电脑上全新安装了 Go，然后是

go get -u github.com/swaggo/swag/cmd/swag

和

swag

在蝙蝠右侧运行。早些时候，我遵循了 this 教程，但我可能不小心弄乱了原始 PC 上的

$GOPATH

。

Answer 1

将 $GOPATH/bin 添加到 PATH，例如：

导出 PATH=$PATH:/Users/.../go/bin

Answer 2

按照下面的文章来炫耀杜松子酒

https://levelup.gitconnected.com/tutorial-generate-swagger-specation-and-swaggerui-for-gin-go-web-framework-9f0c038483b5

如果您在获取 swag 时遇到任何问题，请使用以下命令在 Windows 上获取 swag

go install github.com/swaggo/swag/cmd/swag

Answer 3

错误消息表明无法识别

swag

命令，这通常意味着

swag

可执行文件未安装或不在系统的 PATH 中。

确保已安装 Go :
- 首先，确保您的系统上安装了 Go。您可以从官方Go网站下载并安装Go。
添加转到系统路径：
- 安装Go后，您需要将Go二进制目录添加到系统的PATH中。这允许从任何命令提示符或终端窗口识别
```
go
```
  命令。

第 1 步：在 Windows 上添加 Go 到 PATH

找到Go安装路径：
- 默认情况下，Go 安装在
```
C:\Go
```
  中。二进制目录是
```
C:\Go\bin
```
  。
打开环境变量:
- 右键单击桌面或文件资源管理器中的
```
This PC
```
  或
```
Computer
```
  。
- 点击
```
Properties
```
  。
- 点击
```
Advanced system settings
```
  。
- 点击
```
Environment Variables
```
  。
编辑 PATH 变量:
- 在
```
System variables
```
  部分中，找到
```
Path
```
  变量并选择它。
- 点击
```
Edit
```
  。
- 单击
```
New
```
  并添加 Go 二进制目录的路径，例如
```
C:\Go\bin
```
  。就我而言，我选择通过
```
D:Program_Files\Go\bin
```
  下载。路径。
应用更改:
- 单击
```
OK
```
  关闭所有对话框。

然后让我们完成这些步骤，以确保

swag

已正确安装并在您的 PATH 中可用。

第2步：安装

swag

首先，使用

swag

安装

go install

工具：

go install github.com/swaggo/swag/cmd/swag@latest

第3步：将Go Bin目录添加到PATH

确保 Go 工作区的

bin

目录位于系统的 PATH 中。在 Windows 上，您可以按照以下步骤执行此操作：

打开环境变量:
- 右键单击桌面或文件资源管理器中的
```
This PC
```
  或
```
Computer
```
  。
- 点击
```
Properties
```
  。
- 点击
```
Advanced system settings
```
  。
- 点击
```
Environment Variables
```
  。
编辑 PATH 变量:
- 在
```
System variables
```
  部分中，找到
```
Path
```
  变量并选择它。
- 点击
```
Edit
```
  。
- 单击
```
New
```
  并将路径添加到 Go 工作区的
```
bin
```
  目录。这是典型的
```
C:\Users\YourUsername\go\bin
```
  。
应用更改:
- 单击
```
OK
```
  关闭所有对话框。

$In my case downloaded by D:Program_Files\Go\bin.$

验证安装

打开新的命令提示符或 PowerShell 窗口，并通过运行以下命令验证

swag

是否已正确安装：

swag -v

注意：当我通过管理员模式运行 Windows Powershell 时，可以使用。

您应该会在终端中看到打印的

swag

版本。

生成 Swagger 文档

导航到您的项目目录并运行

swag init

命令来生成 Swagger 文档：

swag init

注意：当我通过管理员模式运行 Windows Powershell 时，可以使用。

运行您的应用程序：

go run main.go

访问 Swagger UI:

打开浏览器并导航到

http://localhost:8080/swagger/index.html

以查看 Swagger UI 和 API 文档（默认端口 8080，但我的应用程序在 9097 端口上运行。）：

通过执行这些步骤，您应该能够为 Go 项目生成 Swagger 文档并使用 Swagger UI 测试您的端点。

Answer 4

首先清除缓存

-go clean --modcache

如何在go中安装swagger

-https://libraries.io/go/github.com%2Fswaggo%2Fhttp-swagger

-转到您的文件路径，安装以下软件包 1-

go get github.com/swaggo/http-swagger

2-使用以下方式下载 Go 版 Swag：

-go get github.com/swaggo/swag/cmd/swag

3-在包含 main.go 文件的 Go 项目根文件夹中运行 Swag，Swag 将解析注释并生成所需文件（docs 文件夹和 docs/doc.go）。

-swag init

4.使用以下方式下载http-swagger：

- go get -u github.com/swaggo/http-swagger

5-运行它，然后浏览器

-http://localhost:1323/swagger/index.html

，可以查看Swagger 2.0 Api文档。

并了解您正在选择的路径类型

-go env

然后寻找

GOPATH=

，在那里你会看到你的路径

在Windows上安装swaggo（swagger + gin）

问题描述投票：0回答：4

4个回答

第 1 步：在 Windows 上添加 Go 到 PATH

第2步：安装
`swag`

第3步：将Go Bin目录添加到PATH

验证安装

生成 Swagger 文档

运行您的应用程序：

访问 Swagger UI:

最新问题

在Windows上安装swaggo（swagger + gin）

问题描述 投票：0回答：4

4个回答

第 1 步：在 Windows 上添加 Go 到 PATH

第2步：安装swag

第3步：将Go Bin目录添加到PATH

验证安装

生成 Swagger 文档

运行您的应用程序：

访问 Swagger UI:

最新问题

问题描述投票：0回答：4

第2步：安装
`swag`