Post - 友好速搭 -- 使用手册

友好速搭

开放 API
使用说明 获取授权 全部 API 特殊 API 开放功能

Post

Post

Post 为网站的文章信息

Post 相关API

GET /posts获取文章列表GET /posts/:id获取单篇文章的信息GET /posts/tags所有的文章标签GET /posts/tags/:id单个的文章标签GET /posts/dirs所有的文章目录 GET /posts/dirs/:id单个文章目录POST /posts/创建文章

Post 属性

    • id
    •   { "id": 1234 }
      
      Integer 类型,文章的唯一整型标识。
    • handle
    •   { "handle" : "x000006" }
      
      String 类型,文章的自定义标识。
    • title
    •   { "title" : "ABCD"}
      
      String 类型,文章的标题。
    • summary
    •   { "summary" : "简介内容AAA"}
      
      String 类型,文章的简介。
    • publish_at
    •   { "publish_at" : "2015-01-25T22:31:06.155+08:00"}
      
      Datetime 类型,文章的发布时间。
    • page_title
    •   { "page_title" : "T234" }
      
      String 类型,文章的分享标题。
    • page_keywords
    • { "page_keywords" : "关关" }
      
      String 类型,文章的网页关键词。
    • created_at
    • { "created_at" : "2015-01-25T22:31:06.155+08:00" }
      
      Datetime 类型,文章的创建时间。
    • updated_at
    • { "updated_at" : "2015-01-25T22:31:06.155+08:00" }
      
      Datetime 类型,文章的更新时间。
    • page_description
    •   { "page_description" : "喵喵蜀黍" }
      
      String 类型,文章的网页/分享描述。
    • content
    •   { "content" : "文章内容" }
      
      String 类型,文章的内容。
    • tags
    •   { "tags" : ["a", "b"] }
      
      Array 类型,文章的标签。
    • dirs
    •   { "dirs" : ["目录1", "目录2"] }
      
      Array 类型,文章的目录。
    • share_image
    • Object 类型,文章的分享头图。
    • cover_image
    • Object 类型,文章的封面图。

GET /posts

获取文章列表

    • limit
    • 显示条数(默认10,最大50)
    • page
    • 显示页码(默认1)
    • since_id
    • 筛选id大于since_id的Order
    • fields
    • ,拼接Response显示的字段
    • title
    • 查询文章的标题,使用模糊匹配
    • tag
    • 查询文章的标签,使用模糊匹配
    • dir
    • 查询文章的目录,使用模糊匹配
    • id
    • 查询指定id
    • ids
    • ,拼接要显示的id范围
    • 获取文章列表
    • GET /posts
    • HTTP/1.1 200 OK

      {
      "posts": [
          {
              "content": "<p>文章内容</p>",
              "cover_image":{"epoch": "1502704947", "height": 900, "id": 2008, "image_id": "59917530fc165b32d3000002",…},
              "created_at": "2017-08-01T17:31:24.680+08:00",
              "dirs":[["未2" ], ["未分类目录" ]],
              "handle": "x000006",
              "id": 1220,
              "page_description": "描述描述",
              "page_keywords": "关键关键",
              "page_title": "标题标题",
              "publish_at": "2017-08-01T17:31:49.432+08:00",
              "share_image": null,
              "summary": "简介哟",
              "tags":["a", "b"],
              "title": "思来想去",
              "updated_at": "2017-08-15T16:34:35.499+08:00"
          }
      ]
      }
      

GET /posts/:id

获取单篇文章的信息

    • 获取单篇文章信息
    • GET /posts/1220
    • HTTP/1.1 200 OK

      {
      "post": {
          "content": "<p>文章内容</p>",
          "cover_image":{"epoch": "1502704947", "height": 900, "id": 2008, "image_id": "59917530fc165b32d3000002",…},
          "created_at": "2017-08-01T17:31:24.680+08:00",
          "dirs":[["未2" ], ["未分类目录" ]],
          "handle": "x000006",
          "id": 1220,
          "page_description": "描述描述",
          "page_keywords": "关键关键",
          "page_title": "标题标题",
          "publish_at": "2017-08-01T17:31:49.432+08:00",
          "share_image": null,
          "summary": "简介哟",
          "tags":["a", "b"],
          "title": "思来想去",
          "updated_at": "2017-08-15T16:34:35.499+08:00"
      }
      }
      

GET /posts/tags

所有的文章标签

    • 所有的文章标签
    • GET /posts/tags
    • HTTP/1.1 200 OK
      {
          "tags":[
              {
                  "id": 185,
                  "name": "a"
              },
              {
                  "id": 186,
                  "name": "b"
              }
          ]
      }
      

GET /posts/tags/:id

单个的文章标签

    • 单个文章标签的信息
    • GET /posts/tags/185
    • HTTP/1.1 200 OK
      {
          "tag":{
              "id": 185,
              "name": "a"
          }
      }
      

GET /posts/dirs

所有的文章目录

    • 所有的文章目录
    • GET /posts/dirs
    • HTTP/1.1 200 OK
      {
          "dirs":[
              {
                  "id": 1656,
                  "name": "未分类目录",
                  "parent_dir_id": 1653,
                  "post_count": 0
              },
              {
                  "id": 1655,
                  "name": "未分",
                  "parent_dir_id": 1653,
                  "post_count": 0
              }
          ]
      }
      

GET /posts/dirs/:id

单个文章目录

    • 单个文章目录
    • GET /posts/dirs/1656
    • HTTP/1.1 200 OK
      {
          "dirs":{
              "id": 1656,
              "name": "未分类目录",
              "parent_dir_id": 1653,
              "post_count": 0
          }
      }
      

POST /posts/

创建文章

    • handle
    • 文章的访问路径
    • title
    • 文章标题
    • content
    • 文章内容
    • publish_at
    • 发布时间
    • page_title
    • seo title信息
    • page_keywords
    • seo 关键字
    • page_description
    • seo 描述信息
    • visibility
    • 文章是否发布 true / false
    • share_image_id
    • 分享头图id
    • cover_image_id
    • 封面图片id
    • tags
    • 标签名,array类型,可以传递多个,若无当前标签,则会进行创建
    • dirs
    • 文章所在目录,array类型,同tags
    • 创建文章
    • POST /posts/
      {
        "post":{
          "title":"测试", 
          "content":"测试内容",
          "tags":["测试标签", "测试标签2"],
          "dirs":["测试目录1", "测试目录2"]
        }
      }
      
    • HTTP/1.1 200 OK
      {
      "post": {
          "content": "测试内容",
          "cover_image": null,
          "created_at": "2019-06-30T11:22:26.520+08:00",
          "dirs": [
              "测试目录1",
              "测试目录2"
          ],
          "handle": "x000049",
          "id": 1852,
          "page_description": "",
          "page_keywords": "",
          "page_title": "",
          "publish_at": "2019-06-30T11:22:26.520+08:00",
          "share_image": null,
          "summary": null,
          "tags": [
              "测试标签",
              "测试标签2"
          ],
          "title": "测试",
          "updated_at": "2019-06-30T11:22:26.520+08:00"
      }
      }
      
以上内容仍未解决您的问题? 联系在线客服
免费领取15天试用
立即注册
联系客服
微信咨询
微信二维码

领取免费试用资格

姓名 *

电话 *

公司名称

所在地区

意向产品

提交

提交成功

你好, XXX女士/先生 ,你的需求已提交成功,后续会有专门的客户经理与你电话联系。谢谢!