• 简介
  • 目录
  • 获取请求
  • 响应结果
    • 统一返回数据格式
    • Response结构

    简介

    建议非GET类的请求，每一个接口都需要定义Request和Response的数据结构实体，使用Content-Type:applicatoin/json方式提交请求。

    目录

    app/http/entities

    获取请求

    通过路由层定义处理的controller回调函数，函数的输入参数会注入*gin.Context的变量，通过此变量可以获取请求参数、URL、Host、Method、Body、Ip等，具体参数的话可以查看Gin框架的文档。

    在服务端通过调用如下方法，可以将json字符串的请求数据转换为数据结构实体。

    1. request := new(entities.UserCreateRequest)
    2. err := genRequest(c, request)

    响应结果

    统一返回数据格式

    成功返回

    1. {
    2.     "code": 200,
    3.     "message": "ok",
    4.     "request_uri": "/user/create",
    5.     "data": response,  //response根据业务再具体定义
    6. }

    失败返回

    1. {
    2.     "code": 404,
    3.     "message": "params error",
    4.     "request_uri": "/user/create",
    5.     "data": {},
    6. }

    Response结构

    在目录 app/http/entities 定义响应结果的业务相关性的数据结构实体