高校网站群建设的公司有哪些,织梦做电子商务网站,三好街 做网站,wordpress 怎么登录最近需要使用Go写一个Web API项目#xff0c;可以使用Beego与Gin来写此类项目#xff0c;还是非常方便的#xff0c;这里就介绍一下使用Beego来创建的Web API项目并自动化文档的方法。
使用Gin创建API项目并自动化文档参见#xff1a;使用Gin编写Web API项目并自动化文档 …最近需要使用Go写一个Web API项目可以使用Beego与Gin来写此类项目还是非常方便的这里就介绍一下使用Beego来创建的Web API项目并自动化文档的方法。
使用Gin创建API项目并自动化文档参见使用Gin编写Web API项目并自动化文档
一、准备环境
go install github.com/beego/bee/v2latest二、创建API项目
bee api api. 下载项目依赖
$ cd api
$ go mod tidy此时项目目录结构如下
$ tree
.
├── conf
│ └── app.conf
├── controllers
│ ├── object.go
│ └── user.go
├── go.mod
├── go.sum
├── main.go
├── models
│ ├── object.go
│ └── user.go
├── routers
│ └── router.go
└── tests└── default_test.go6 directories, 10 files
. 生成路由
bee generate routers该命令会生成routers/commentsRouter.go文件。
$ tree
.
├── conf
│ └── app.conf
├── controllers
│ ├── object.go
│ └── user.go
├── go.mod
├── go.sum
├── main.go
├── models
│ ├── object.go
│ └── user.go
├── routers
│ ├── commentsRouter.go
│ └── router.go
└── tests└── default_test.go6 directories, 11 files
此时可以在浏览器中浏览http://127.0.0.1:8080/v1/user/ 注意这里不能使用https
三、自动化文档与测试
每次手动测试API还是比较繁琐的为了方便测试可以使用swagger来进行API辅助测试。
bee run -gendoctrue -downdoctrue此时默认使用的是https://petstore.swagger.io/v2/swagger.json配置文件 可以手动将前面的路径去掉只保留swagger.json然后测试会发现有问题 Failed to fetch.
Possible Reasons:CORS
Network Failure
URL scheme must be http or https for CORS request.需要修改swagger/index.html 将url: https://petstore.swagger.io/v2/swagger.json替换成url: /swagger/swagger.json。再测试就正常了 如何写注释让swagger自动生成接口文档可以参考https://beego.wiki/zh-cn/docs/advantage/docs/
