api_open_sdk 杭电助手自用 sdk

配置网络

https://goproxy.cn/

前置步骤

linux

//安装 编译所需的插件
//包括 buf protoc-gen-grpc-gateway protoc-gen-openapiv2 protoc-gen-go-grpc protoc-gen-go
//在 tools.go 中控制 要安装的插件列表，使用 go module 管理插件版本
make install-tools

windows

如果使用goland，建议安装插件：buf、Protocol Buffers Support，以消除proto无法识别到的报警。

以下操作，开发前或开发后执行皆可

go get github.com/bufbuild/buf/cmd/buf@latest
go get github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway@latest
go get github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2@latest
go get google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
go get google.golang.org/protobuf/cmd/protoc-gen-go@latest

然后刷新一下。

go mod tidy
buf generate

依赖

• go-task
• golangci-lint

开发流程

1. 修改 proto 文件
2. 运行 buf generate
3. 开启 swagger-ui 实时预览

预览 swagger 效果 (多数情况下没必要预览) (感觉还有更简单的)

公开文档

在 https://github.com/hduhelp/api/config.json 中添加对应 OpenAPI 文件，提交后会自动拉取api_open_sdk最新文档

可在 https://hduhelp.github.io/api/ 页面查看接口文档

1. 安装 swagger-ui

# 新建目录
git clone https://github.com/swagger-api/swagger-ui.git
cd swagger-ui
npm install
npm run dev

2. 安装 http-server

npm install --global http-server
# 切回 api_open_sdk 根目录
cd docs/swagger-ui
http-server --cors

3. 访问 swagger-ui 访问 http://localhost:3200/
   在地址栏内输入 json 的相对路径，如： http://localhost:8080/campusapis/staff/v1/freshman.swagger.json 点击 Explore 按钮，即可看到 swagger 文档

4. 每次改动 proto 后需要重新运行 buf generate，并且「清空缓存并进行硬刷新」网页

接口注释

• 有效：rpc 方法前，Response message 前，message内部字段前
• 无效（不会显示到 swagger 中）：Request message 前