IT数码 购物 网址 头条 软件 日历 阅读 图书馆
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
图片批量下载器
↓批量下载图片,美女图库↓
图片自动播放器
↓图片自动播放器↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
开发: C++知识库 Java知识库 JavaScript Python PHP知识库 人工智能 区块链 大数据 移动开发 嵌入式 开发工具 数据结构与算法 开发测试 游戏开发 网络协议 系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁
 
   -> 系统运维 -> 关于goframe2.0规范路由个人见解(一) -> 正文阅读

[系统运维]关于goframe2.0规范路由个人见解(一)

开篇

goframe是一款模块化、高性能、企业级的Go基础开发框架。虽然goframe不像Gin那么出名,但goframe用下来的感受是非常舒服的。它有全中文的官方文档,开发团队与用户之间保持了良好沟通,对用户的信息及时反馈。goframe开发团队一直在积极地进行维护和更新,近期推出的goframe2.0版与之前1.16版有很大的提高与变动。
在此我打算跟大家分享一下我对goframe2.0标准路由的使用心得,如有不妥欢迎留言讨论。

api请求结构体Meta

写标准路由首先要写请求结构体与响应结构体,对api请求与响应接口进行描述。先来看代码模板里的请求结构体:

type HelloReq struct {
	g.Meta `path:"/hello" tags:"Hello" method:"get" summary:"You first hello api"`
}

在这段代码中可以看到在请求结构体中有路由地址、请求方法、接口描述、标签分类等信息,内容如下:

tags:接口分类标签(重要)

tags是标签分类信息,tags相同的api会合并在同一标签下展示。tags是对数据表的描述,是多个对同一张表进行不同操作的api共同使用的分类标签。
请看下图红色方框圈住的部分,通知管理tags下有4个api,分别是增删改查,4个api的共同特征是它们都是对Notice通知表进行操作,那么应该将这4个api的请求结构体tags都写成“通知管理”,这样这4个api会归在一起。
在这里插入图片描述

summary:接口详情描述(重要)

summary是api执行的动作描述,说明api做了什么动作。
请看上图,通知管理下有4个api,分别是增删改查。
NoticeAdd函数做的工作是新增通知,那么它的summary推荐的写法是“新增”;
NoticePut函数做的工作是修改通知,那么它的summary推荐的写法是“修改”;
其他的以此类推,不再赘述。

path:路由名(强烈不推荐)

path是api的路由名。但我极其不推荐在请求结构体里写path,具体原因有下面两条:
一是在请求结构体里写path很容易造成路由冲突。假设某个函数的请求结构体的路由是/get,另一个函数在路由表中也是/get,若它们在同一级路由下(假设都在/api下)就会造成路由冲突,造成项目启动失败。
二是path分散在不同的请求结构体中写,以后修改起来很麻烦,可维护性差。

method:请求方法(不推荐)

method是请求方法,例如get、post、put等等。但我也不推荐在请求结构体中写method,因为在请求结构体里写没有代码提示,在路由表中函数中写有代码提示。

  系统运维 最新文章
配置小型公司网络WLAN基本业务(AC通过三层
如何在交付运维过程中建立风险底线意识,提
快速传输大文件,怎么通过网络传大文件给对
从游戏服务端角度分析移动同步(状态同步)
MySQL使用MyCat实现分库分表
如何用DWDM射频光纤技术实现200公里外的站点
国内顺畅下载k8s.gcr.io的镜像
自动化测试appium
ctfshow ssrf
Linux操作系统学习之实用指令(Centos7/8均
上一篇文章      下一篇文章      查看所有文章
加:2022-04-06 16:28:46  更:2022-04-06 16:28:55 
 
开发: C++知识库 Java知识库 JavaScript Python PHP知识库 人工智能 区块链 大数据 移动开发 嵌入式 开发工具 数据结构与算法 开发测试 游戏开发 网络协议 系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁

360图书馆 购物 三丰科技 阅读网 日历 万年历 2024年11日历 -2024/11/15 21:54:29-

图片自动播放器
↓图片自动播放器↓
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
图片批量下载器
↓批量下载图片,美女图库↓
  网站联系: qq:121756557 email:121756557@qq.com  IT数码