このページに関して
API のテンプレートを記述します。この書式に従って記述してください。
[Web API]
API 名
APIの説明、概要。
リクエスト URL
GET/POST または GET、POST http://~。変数は { } でくくる。
ex) GET http://ext.nicovideo.jp/api/getthumbinfo/{video_id}
- video_id
ビデオ ID
データ形式
正常な場合のデータ形式を解説する。詳細解説はなくてもいいかも。わかりにくいところだけピックアップするのもよし。
ex) XML 形式。
- nicovideo_thumb_response
status- thumb
- video_id
ID - title
題名 - :
- :
- tags
タグ一覧
domain
言語- tag
タグ
category
[省略可] カテゴリー ロックあれているか
lock
[省略可] タグ ロックされているか
- tag
- user_id
ユーザー投稿動画のみ存在する。ユーザー ID - :
- :
- video_id
- thumb
データサンプル
データサンプルに関する状態
データサンプルを記述する。成功例、失敗例ともに記述すること。また行数は必要な場合のみ表示すればよい (linenumber 指定)
(ex) 正常な場合
<root>
<parent>
<child attribute="yes!" />
</parent>
</root>
(ex) 不正な場合
JSON は http://www.ctrlshift.net/jsonprettyprinter/ で整形するとよい。
- {
- "parent": {
- "child": {
- "attribute": "yes!"
- }
- }
- }
関連API
関連した項目を列挙。たとえばデータ構造が同じなど。
ex) -ページリンク (補足説明)
更新履歴
変更があった場合、変更を記述するほうが好ましい…?
ex) 2014/2/6 記述