跳到主要内容

HTTP工具包

本章节阐述HTTP工具包是什么.

简介​

HTTP工具包提供统一的响应、路由中间件以及通用的请求和响应实体。

路由中间件​

路由中间件是与gin适配的，你依然可以单独使用它们。

路由中间件提供了一些常用的功能：

  • 解析客户端语言
  • 链路日志追踪
  • 打印请求载荷
  • Prometheus导出器
  • 限流器
  • Cors (Cross-origin resource sharing)跨域资源共享
提示

我们将在后续章节中详细介绍其目的和用法。

请求、响应实体规范​

  • dto
    • base
    • pagination
    • error
  • vo
    • pagination
提示

我们将在后续章节中详细介绍其目的和用法。

统一响应​

首先，统一响应使得响应数据结构高度统一和完整。 其次，响应实体中的一些数据值由Go-Sail维护，不需要开发人员过多关心，这有助于开发人员将精力集中在其他地方。
一般结构和格式如下：

{
  "code": 200,
  "data": null,
  "message": "SUCCESS",
  "requestId": "5686efa5-c747-4f63-8657-e6052f8181a9",
  "success": true,
  "ts": 1670899688591
}
提示

响应器需要配合注册错误码以及路由中间件来一起使用，相对于拆箱即用的组件库来说稍显复杂，因此不太推荐单独使用。
当然，如果你喜欢响应器提供的功能又想单独使用它，恰好你又富有钻研精神，可以试着自由组合一下。