使用Beego创建API项目并自动化文档

最近需要使用Go写一个Web API项目,可以使用Beego与Gin来写此类项目,还是非常方便的,这里就介绍一下使用Beego来创建的Web API项目并自动化文档的方法。

使用Gin创建API项目并自动化文档参见:使用Gin编写Web API项目并自动化文档

一、准备环境

bash 复制代码
go install github.com/beego/bee/v2@latest

二、创建API项目

bash 复制代码
bee api api

1. 下载项目依赖

bash 复制代码
$ cd api
$ go mod tidy

此时项目目录结构如下:

bash 复制代码
$ 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.go

6 directories, 10 files

2. 生成路由

bash 复制代码
bee generate routers

该命令会生成routers/commentsRouter.go文件。

bash 复制代码
$ 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.go

6 directories, 11 files

此时可以在浏览器中浏览:http://127.0.0.1:8080/v1/user/

注意,这里不能使用https

三、自动化文档与测试

每次手动测试API还是比较繁琐的,为了方便测试,可以使用swagger来进行API辅助测试。

bash 复制代码
bee run -gendoc=true -downdoc=true

此时默认使用的是https://petstore.swagger.io/v2/swagger.json配置文件

可以手动将前面的路径去掉,只保留swagger.json,然后测试,会发现有问题:

bash 复制代码
	
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/

相关推荐
flashman9113 小时前
python在word中插入图片
python·microsoft·自动化·word
2401_8576226613 小时前
SpringBoot健身房管理:敏捷与自动化
spring boot·后端·自动化
力姆泰克13 小时前
看电动缸是如何提高农机的自动化水平
大数据·运维·服务器·数据库·人工智能·自动化·1024程序员节
BPM_宏天低代码13 小时前
低代码 BPA:简化业务流程自动化的新趋势
运维·低代码·自动化
IT-民工2111015 小时前
CI/CD 实践总结
运维·ci/cd·自动化
小趴菜不能喝17 小时前
spring boot 3.x 整合Swagger3
java·spring boot·swagger
_.Switch17 小时前
Serverless架构与自动化运维
运维·python·缓存·自动化·运维开发
孤蓬&听雨17 小时前
RabbitMQ自动发送消息工具(自动化测试RabbitMQ)
分布式·测试工具·自动化·rabbitmq·自动发送消息
独行soc19 小时前
#渗透测试#SRC漏洞挖掘# 操作系统-Linux系统基础04之内存管理
linux·运维·服务器·安全·自动化
IT闫21 小时前
ONLYOFFICE 8.2深度测评——助力自动化办公
运维·自动化·可用性测试