差别

这里会显示出您选择的修订版和当前版本之间的差别。

到此差别页面的链接

api:wikis [2012-06-21 00:02]
Ariagle Lee [返回结果]
api:wikis [2015-01-09 22:32] (当前版本)
行 1: 行 1:
 +====== Wikis 条目列表 ======
  
 +根据条件获取条目列表。
 +
 +
 +===== URL =====
 +[[http://api.moefou.org/wikis.format]]
 +
 +
 +===== 支持格式 =====
 +  * JSON
 +  * XML
 +
 +
 +===== HTTP请求方式 =====
 +GET
 +
 +
 +===== 认证方式 =====
 +  * API Key 认证
 +  * OAuth 认证
 +
 +
 +===== 请求参数 =====
 +^  ^ 必填  ^ 类型  ^ 默认值  ^ 说明  ^
 +^ wiki_type  | true  | string | null | 条目类型,多个类型以半角逗号隔开,如 wiki_type=music,radio。可使用 anime 代替 tv、ova、oad、movie 类型。 |
 +^ page  | false  | int | 1 | 当前页数。|
 +^ perpage  | false  | int | 20 | 每页条目数,取值范围为 [1, 50]。|
 +^ initial  | false  | string | 1 | 条目标题首字母,如 initial=f 表示以字母 f 开头的条目。|
 +^ tag  | false  | string | null | 条目标签,多个标签以半角逗号隔开。|
 +^ wiki_id  | false  | string | null | 条目 id,多个 id 以半角逗号隔开,可以用此获取多条指定的条目。|
 +^ date  | false  | string | null | 时间范围,日期格式为 YYYY[-MM[-DD]]。可使用半角逗号分隔起止日期,如 date=2012-01,2012-03 表示 2012 年 1 月 1 日到 3 月 31 日。|
 +
 +
 +===== 注意事项 =====
 +
 +**关于 date 参数:**
 +
 +  * 当只限定一个日期时,则该日期作为起始及结束时间。如 date=2011 表示 2011 全年(2011-01-01 到 2011-12-31),date=2011-10 表示 2011 年整个 10 月(2011-10-01 到 2011-10-31)。
 +  * 当限定两个日期(起,止)时,结束日期的整个时间段也将包含在内。如 date=2011,2012 表示 2011 年初到 2012 年年末(2011-01-01 到 2012-12-31),date=2011-09,2011-11 表示 2011 年 9 月初到 11 月底(2011-09-01 到 2011-11-30)。
 +
 +
 +===== 返回结果 =====
 +
 +例:获取 music 类型的条目,每页 2 篇,时间范围在 2011 年 9 月到 2012 年全年,并限定标签为“东方”。
 +
 +GET [[http://api.moefou.org/wikis.json?wiki_type=music&perpage=2&date=2011-09,2012&tag=东方]]
 +
 +<code javascript wikis_example.json>
 +{
 +  "response":{
 +    "information":{
 +      "parameters":{ // 请求的参数
 +        "wiki_type":"music",
 +        "perpage":"2",
 +        "date":"2011-09,2012",
 +        "tag":"\u4e1c\u65b9"
 +      },
 +      "msg":[ ],
 +      "has_error":false, // has_error==true 时说明找不到结果
 +      "request":"\/wikis.json?wiki_type=music&perpage=2&date=2011-09%2C2012&tag=%E4%B8%9C%E6%96%B9",
 +      "page":1, // 当前页数
 +      "perpage":2, // 每页数目
 +      "count":89 // 总计 89 个条目
 +    },
 +    "wikis":[
 +      {
 +        "wiki_id":9106,
 +        ... ..., // wiki 的其他基本信息
 +        "wiki_user_fav":null // 当前登录用户未收藏此条目
 +      },
 +      {
 +        "wiki_id":9530,
 +        ... ..., // wiki 的其他基本信息
 +        "wiki_user_fav": // 当前用户已收藏此条目
 +        {
 +           "fav_id":1232,
 +           "fav_obj_id":9530,
 +           "fav_obj_type":"music",
 +           "fav_uid":1,
 +           "fav_date":1320075525
 +           "fav_type":1
 +        }
 +      }
 +    ]
 +  }
 +}
 +</code>