更新文章

基本信息

接口名称： 更新文章

接口类型： 数据更新

接口说明： 更新一篇文章

详细信息

URL

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

完整URL示例

https://www.baklib.com/api/v1/articles/2035cb75-8def-4136-9689-f53d1c204a09

HTTP请求方式

PUT

授权认证方式

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

Authorization: Bearer <token>

请求参数

参数	必选	类型及范围	说明
tenant_id	true	String	站点id
name	false	String	文章标题
channel_id	false	String	栏目id
tag_list	false	Array[String]	标签集
description	false	true	String
content_type	false	string	内容格式，支持'markdown' 和 'paragraph'，默认 'paragraph'
content	false	string	内容
status	false	true	Integer
id	true	String	文章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}",
  name: 'rails 指南',
  tag_list: ['rails', 'doc', 'api'],
  description: '本文介绍如何开始使用 Ruby on Rails。',
  status: 0,
}
response = client.put("/api/v1/articles/#{article_id}", params.to_json)
JSON.parse(response.body)

返回结果

{
  "code": 0,
  "status": "success",
  "message": {
    "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": [
      "rails",
      "doc"
    ]
  }
}

返回字段说明

返回值字段	字段类型	说明
code	Integer	状态码
status	String	返回状态
id	String	栏目id
parent_id	String	栏目id
name	String	文章标题
identifier	String	栏目唯一标识符
description	String	文章描述
content	Jsonb	文章内容
ordinal	String	文章排序
status	Integer	文章状态
status_name	String	栏目状态中文名称
tenant_id	String	站点id
visits_count	Integer	阅读数量
created_at	Datetime	创建时间
updated_at	Datetime	更新时间
created_by	String	创建者id
updated_by	String	更新者id
tag_list	Array[String]	标签集

Overview - 总览

站点