Skip to content

Commit

Permalink
chore: update README.MD
Browse files Browse the repository at this point in the history
  • Loading branch information
oldme-git committed Nov 22, 2024
1 parent b72fb3f commit bb94d7d
Showing 1 changed file with 0 additions and 9 deletions.
9 changes: 0 additions & 9 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,6 @@
- 富文本图片文件处理
- 后台登录认证

# 特色功能设计
## 接口异常和错误的区别
业务开发中通常有**错误****异常**两种 `err`我这里暂且这么称呼也有的称为业务异常错误和系统异常异常)。错误是由用户输入不当引起的比如说账号密码错误这种 `err` 通常只返回给用户即可不需要打印堆栈信息而异常是由系统内部自发引起的比如说 `SQL` 语句不当这种错误需要打印堆栈信息且不能把 `err` 返回到用户那里`oldme-api` 合理的处理了两种不同的 `err`他们体现在 `intrnal->pecked->err.go`

## model设计
网站的前后台接口响应通常是不一样的前台接口的响应数据总是要过滤掉一些敏感信息比如文章的软删除字段就不能返回给前台接口
`gf` 的标准路由中以一个结构体来定义一个接口的响应数据结构按照简单的设计后台和前台应各自定义一个结构体用来处理不同的响应但像文章标题作者创建时间这种信息是两者公用的我们的两个结构体就不可避免的大量定义重复的字段
为了解决这个问题我们可以基于 `gf` 生成的标准数据结构也就是 `model.entity` 下的文件在此基础上使用空结构体和 `omitempty` 标签来剔除掉不想返回的信息这样就可以优雅的解决这一问题请参考:https://github.com/oldme-git/oldme-api/blob/master/internal/model/article.go

# 部署
- git clone https://github.com/oldme-git/oldme-api
- 安装 mysql 数据库运行 manifest/sql/oldme.sql 文件
Expand Down

0 comments on commit bb94d7d

Please sign in to comment.