文章目錄

• 介面規範
• 版本控制
• 狀態碼(待完善)
• 響應體結構
• 登入介面
• 描述：
• 請求url：
• 請求方式：
• 請求引數：
• 請求示例：
• 返回引數：
• 返回示例：
• 儲存文章介面
• 描述：
• 請求url：
• 請求方式：
• 請求引數：
• 請求示例：
• 返回引數：
• 返回示例：
• 獲取文章列表介面
• 描述：
• 請求url：
• 請求方式：
• 請求引數：
• 請求示例：
• 返回引數：
• 返回示例：
• 獲取文章詳情介面
• 描述：
• 請求url：
• 請求方式：
• 請求引數：
• 請求示例：
• 返回引數：
• 返回示例：

介面規範

版本控制

• 需要給介面增加版本資訊，如：/api/v1.0/user/login

狀態碼(待完善)

響應體結構

登入介面

描述：

• 使用者認證使用jwt方式

請求url：

• 地址: /api/v1/user/login

請求方式：

• POST

請求引數：

請求示例：

{
  "phone": "18888888888",
  "password": "123456",
  "type": 1
}
// 或
{
  "phone": "18888888888",
  "password": "1234",
  "type": 2
}

返回引數：

返回示例：

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxLCJpYXQiOjE1NDE0MDMwMjl9.JCI4SpAegGpl3tNtN4gNHBavl5BdDaXbXmkEupAB-6w",
  "userInfo": {
    "id": "10001",
    "name": "Johnson",
    "phone": "18888888888"
  }
}

儲存文章介面

描述：

• 儲存文章預設為草稿，也可直接釋出

請求url：

• 地址: /api/v1/post/save

請求方式：

• POST

請求引數：

請求示例：

{
  "title": "資料庫設計",
  "abstract": "",
  "content": "## 使用者表",
  "status": 'draft'
}

返回引數：

返回示例：

{
  "id":1, 
  "title": "資料庫設計"
  "abstract": "",
  "content": "## 使用者表",
  "status": "draft",
  "created_at": "2018-08-08",
  "created_at": "2018-08-15",
  "deleted_at": null
}

獲取文章列表介面

描述：

• 文章列表

請求url：

• 地址: /api/v1/post/list

請求方式：

• GET

請求引數：

請求示例：

/api/v1/post/list?pageSize=10&page=2

返回引數：

返回示例：

{
  "pageSize": 10,
  "page": 2,
  "total": 1,
  "list": [{
    "id":1, 
    "title": "資料庫設計"
    "abstract": "",
    "createdAt": "2018-08-08",
    "createdAt": "2018-08-15",
  }]
}

獲取文章詳情介面

描述：

• 儲存文章預設為草稿，也可直接釋出

請求url：

• 地址: /api/v1/post/detail

請求方式：

• GET

請求引數：

請求示例：

/api/v1/post/detail?id=12345

返回引數：

返回示例：

{
  "id":12345, 
  "title": "資料庫設計"
  "content": "## 使用者表",
  "status": "draft",
  "created_at": "2018-08-08",
  "created_at": "2018-08-15",
  "deleted_at": null
}