ubdframe

ubdframe

介绍

通用业务框架（Universal business design） 以相对通用的业务逻辑适用于日常用到的业务模块，可以此作为基础搭建的框架

安装教程

使用说明

见 examples 下的使用

API文档

项目支持swagger文档自动生成

swag官方库： https://github.com/swaggo/swag

使用方法可见swagger官方文档，部分文档示例：

swagger通用信息示例： https://github.com/swaggo/swag/blob/master/example/celler/main.go

API信息示例： https://github.com/swaggo/swag/blob/master/example/celler/controller/examples.go

1、安装swagger-go（swag）

可参考官方文档README进行安装 或直接按以下方式安装

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

安装后会在 GOPATH/bin 下生成swag.exe可执行文件后可使用swag命令

2、生成文档（手动）

API文档swagger描述信息已在代码中定义，并可自动生成swagger json和docs.go

自动生成命令如下：

swag init -g example/main/docs.go

如遇到引入依赖库变量的可额外加以下参数来自动生成

swag init -g src/main/main.go --parseDependency --parseInternal

不同微服务可生成自己的docs文档

#单独生成admin-service的docs
# 在对应服务下执行
cd src/admin-service
swag init -g main/start.go --parseDependency --parseInternal --instanceName adminservice

3、生成文档（自动/快速）

API文档swagger生成脚本已在各app中写好

如：

cd src/apps/adminapp
sh gen_docs.sh

4、运行并查看文档

使用以下命令启动docs站点

go run cmd/microdocs/main.go

运行后浏览器访问查看： http://127.0.0.1:8080/swagger/index.html