获取文章列表


基本信息

接口名称: 获取栏目下的文章列表

接口类型: 数据获取

接口说明: 获取一个某个栏目下的文章列表

详细信息

URL

https://www.baklib.com/api/v1/articles

完整URL示例

https://www.baklib.com/api/v1/articles?_page=1&_per_page=2&channel_id=941ec4db-bfae-46c0-8eb3-89f647aba40d&tenant_id=682c1cf8-41bf-4417-aa05-3e682fb5174b

HTTP请求方式

GET

授权认证方式

默认方式,需要添加请求header

conn = Faraday.new(url: url)
conn.headers['Authorization'] = "Bearer #{token}"

请求参数

参数 必选 类型及范围 说明
tenant_id true Integer 站点id
channel_id reuqire Integer 父级栏目id
_page false Integer 需要显示的页码, 默认1
_per_page false Integer 每页显示数量, 默认10, 最大不能超过50

点击获取Token值
点击获取站点id值
点击获取栏目id值

示例代码

require 'faraday'
require 'json'
host = 'https://www.baklib.com/'

client = Faraday.new(url: host) do |conn|
  conn.headers['Authorization'] = "Bearer #{token}"
  conn.headers['Content-Type'] = 'application/json'
  conn.adapter :net_http
end
params = {
  tenant_id: "#{tenant_id}",
  channel_id: "#{channel_id}",
  _page: 1,
  _per_page: 2
}
response = client.get("/api/v1/articles", params)
JSON.parse(response.body)

返回结果

{
  "code": 0,
  "status": "success",
  "message": {
    "meta": {
      "current_page": 1,
      "total_pages": 1,
      "total_count": 2
    },
    "items": [
      {
        "id": "79d8853a-a142-4d68-ac95-ea01f5841b53",
        "parent_id": "941ec4db-bfae-46c0-8eb3-89f647aba40d",
        "name": "rails guide",
        "identifier": "3e20",
        "description": "本文介绍如何开始使用 Ruby on Rails。",
        "content": {},
        "ordinal": 0,
        "features": {},
        "status": 0,
        "status_name": "草稿",
        "kind": 2,
        "kind_name": "文章",
        "slug": "dcc7/3e20",
        "tenant_id": "682c1cf8-41bf-4417-aa05-3e682fb5174b",
        "visits_count": 0,
        "created_at": "2020-04-01T15:09:41.081+08:00",
        "updated_at": "2020-04-01T15:11:38.970+08:00",
        "created_by": "5b062111-13d7-41a2-9d2b-f3e0de23c98c",
        "updated_by": "5b062111-13d7-41a2-9d2b-f3e0de23c98c",
        "tag_list": [
          "doc",
          "rails"
        ]
      },
      {
        "id": "0a8e19b9-3391-47b9-a74e-3a0ff23d5114",
        "parent_id": "941ec4db-bfae-46c0-8eb3-89f647aba40d",
        "name": "rails guide",
        "identifier": "0467",
        "description": "本文介绍如何开始使用 Ruby on Rails。",
        "content": {},
        "ordinal": 0,
        "features": {},
        "status": 0,
        "status_name": "草稿",
        "kind": 2,
        "kind_name": "文章",
        "slug": "dcc7/0467",
        "tenant_id": "682c1cf8-41bf-4417-aa05-3e682fb5174b",
        "visits_count": 0,
        "created_at": "2020-04-01T14:39:02.423+08:00",
        "updated_at": "2020-04-01T15:16:37.077+08:00",
        "created_by": "5b062111-13d7-41a2-9d2b-f3e0de23c98c",
        "updated_by": "5b062111-13d7-41a2-9d2b-f3e0de23c98c",
        "tag_list": [
          "doc",
          "rails"
        ]
      }
    ]
  }
}

返回字段说明

返回值字段 字段类型 说明
code Integer 状态码
status String 返回状态
current_page Integer 当前页数
total_pages Integer 总页数
total_count Integer 总数量
id String 栏目id
parent_id String 父级栏目id
name String 栏目名称
identifier String 栏目唯一标识符
status Integer 栏目状态
status_name String 栏目状态中文名称
tenant_id String 站点id
created_at Datetime 创建时间
updated_at Datetime 更新时间
created_by String 创建者id
updated_by String 更新者id