跳到主要内容

获取片单

GET/v1/collections/{id}

按 ID 返回片单:名称、简介、所有者、主题和各项计数。

请求

Shell
curl -g "https://api.nogitsu.com/v1/collections/{id}"

参数

  • id

    路径必填

    条目的 ID,为 UUID。

    文本

响应

请求成功时返回 200 和以下 JSON:

  • id文本 (uuid)
  • name文本
  • slug文本
  • path文本
  • description文本可为 null
  • visibility文本
    允许的值publicunlistedprivate
  • isOrderedtrue 或 false
  • language文本
    允许的值entrdefresptitruidjakozh
  • itemCount整数

    0 到 9007199254740991

  • subscriberCount整数

    0 到 9007199254740991

  • owner对象
    • username文本
    • displayName文本
    • avatarUrl文本 (uri)可为 null
  • covers对象 列表
    • url文本 (uri)
    • variantWidths整数 列表

      -9007199254740991 到 9007199254740991

  • isRemovedtrue 或 false
  • isIndexabletrue 或 false
  • createdAt文本 (date-time)
  • updatedAt文本 (date-time)
  • theme对象可为 null
    • background文本
    • accent文本
    • font文本
      允许的值defaultserifmono
    • density文本
      允许的值comfortablecompact
    • layout文本
      允许的值rowsposters
    • showsCurrentlyConsumingtrue 或 false
  • copiedFrom对象可为 null
    • name文本
    • path文本
    • ownerDisplayName文本

错误

与所有操作一样,此操作在参数无效时可能返回 400,找不到内容时返回 404,请求过多时返回 429。所有错误的结构都相同。

了解错误