Changeset 12968
- Timestamp:
- Oct 5, 2009, 7:11:43 PM (13 years ago)
- Location:
- OpenPNE3/doc/branches/develop/OpenPNEWebAPI/en/docs
- Files:
-
- 6 edited
-
diary_api.rst (modified) (4 diffs)
-
diary_api/delete_resource.rst (modified) (3 diffs)
-
diary_api/get_feed.rst (modified) (7 diffs)
-
diary_api/get_resource.rst (modified) (4 diffs)
-
diary_api/post_resource.rst (modified) (6 diffs)
-
diary_api/put_resource.rst (modified) (5 diffs)
Legend:
- Unmodified
- Added
- Removed
-
OpenPNE3/doc/branches/develop/OpenPNEWebAPI/en/docs/diary_api.rst
r12887 r12968 1 ============= ===========2 日記に関する API (diary) 3 ============= ===========1 ============= 2 API for Diary 3 ============= 4 4 5 利用可能な機能 6 ============== 5 Available Features 6 ================== 7 7 8 8 .. toctree:: … … 15 15 diary_api/delete_resource 16 16 17 エントリポイント 18 =========== =====17 Entry Point 18 =========== 19 19 20 コレクションURI20 Collection URI 21 21 http://example.com/api.php/feeds/diary 22 22 23 メンバURI24 http://example.com/api.php/feeds/diary/{ 日記のID}23 Member URI 24 http://example.com/api.php/feeds/diary/{ID of the diary} 25 25 26 エントリ文書の書式 27 ================== 26 Format of Entry Document 27 ======================== 28 28 29 日記のエントリは以下のような Atom エントリ文書で表現されます。 29 An entry for a diary is described like the following Atom Entry Document: 30 30 31 31 :: … … 36 36 <published>2009-01-25T19:40:22+09:00</published> 37 37 <updated>2009-01-25T19:40:22+09:00</updated> 38 <title type="text"> 日記タイトル</title>39 <content type="text"> 日記本文</content>38 <title type="text">Title</title> 39 <content type="text">Body</content> 40 40 <author> 41 <name> 投稿したメンバーのニックネーム</name>41 <name>Nickname of Author</name> 42 42 <uri>http://example.com/member/{member_id}</uri> 43 43 </author> … … 48 48 </entry> 49 49 50 このエントリに含まれる要素の解説を以下に示します。 50 The following is explaining for items in this entry. 51 51 52 * /entry/id : エントリを識別するための ID となる URN (省略可) 53 * /entry/published : エントリの作成日時 (省略可) 54 * /entry/updated : エントリの更新日時 (省略可) 55 * /entry/title : エントリのタイトル 56 * /entry/content : エントリの本文 57 * /entry/author : エントリの作成者の情報 58 * /entry/author/name : エントリの作成者のニックネーム 59 * /entry/auhtor/uri : エントリの作成者を識別するための URN 60 * /entry/link[@rel="edit"] : OpenPNE Web API でこのエントリを編集するための URI (省略可) 61 * /entry/link[@rel="self"] : OpenPNE Web API でこのエントリを参照するための URI (省略可) 62 * /entry/link[@rel="alternate" and @type="text/html"] : PC 版でこのエントリを閲覧するための URL (省略可) 63 * /entry/link[@rel="alternate" and not(@type)] : 携帯版でこのエントリを閲覧するための URL (省略可) 52 * /entry/id : URN as ID for identifying the entry (optional) 53 * /entry/published : Created date of the entry (optonal) 54 * /entry/updated : Updated date of the entry (optional) 55 * /entry/title : Title of the entry 56 * /entry/content : Body of the entry 57 * /entry/author : Informations about author of this diary 58 * /entry/author/name : Nickname 59 * /entry/auhtor/uri : URN 60 * /entry/link[@rel="edit"]/@href : URI for editing via OpenPNE Web API (optional) 61 * /entry/link[@rel="self"]/@href : URI for accessing via OpenPNE Web API (optional) 62 * /entry/link[@rel="alternate" and @type="text/html"]/@href : URI for accessing via PC (optional) 63 * /entry/link[@rel="alternate" and not(@type)]/@href : URI for accessing via mobile (optional) 64 * /entry/link[@rel="enclosure"]/@href : An image of the entry (optional) 64 65 -
OpenPNE3/doc/branches/develop/OpenPNEWebAPI/en/docs/diary_api/delete_resource.rst
r12888 r12968 1 1 .. _diary_api_delete_resource: 2 2 3 =================== =4 日記::エントリの削除 5 =================== =3 =================== 4 Diary::Delete Entry 5 =================== 6 6 7 リクエスト 8 ======= ===7 Request 8 ======= 9 9 10 リクエストの方法 11 ---------------- 10 The Way to Request 11 ------------------ 12 12 13 メンバ URI に対して DELETE リクエストをおこなう。 13 Do DELETE to Member URI. 14 14 15 15 :: … … 18 18 Host: example.com 19 19 20 リクエストパラメータ 21 ----------------- ---20 Request Parameter 21 ----------------- 22 22 23 なし 23 None 24 24 25 レスポンス 26 ======== ==25 Response 26 ======== 27 27 28 レスポンスヘッダ 29 --------------- -28 Response Header 29 --------------- 30 30 31 HTTPステータスコード 200 を返す。 31 Returns HTTP Status Code 200. 32 32 33 33 :: … … 35 35 HTTP/1.1 200 Ok 36 36 37 レスポンス本文 38 ------------- -37 Response Body 38 ------------- 39 39 40 なし 40 None -
OpenPNE3/doc/branches/develop/OpenPNEWebAPI/en/docs/diary_api/get_feed.rst
r12888 r12968 1 1 .. _diary_api_get_feed: 2 2 3 ================== ========4 日記::エントリの一覧の取得 5 ================== ========3 ================== 4 Diary::Get Entries 5 ================== 6 6 7 リクエスト 8 ======= ===7 Request 8 ======= 9 9 10 リクエストの方法 11 ---------------- 10 The Way to Request 11 ------------------ 12 12 13 コレクション URI に対して GET リクエストをおこなう。 13 Do GET to Collection URI. 14 14 15 15 :: … … 18 18 Host: example.com 19 19 20 リクエストパラメータ 21 ----------------- ---20 Request Parameter 21 ----------------- 22 22 23 23 * :ref:`q <search-query>` (optional) … … 31 31 * :ref:`sortorder <sortorder-query>` (optional) 32 32 33 レスポンス 34 ======== ==33 Response 34 ======== 35 35 36 レスポンスヘッダ 37 --------------- -36 Response Header 37 --------------- 38 38 39 HTTPステータスコード 200 を返す。 39 Returns HTTP Status Code 200. 40 40 41 41 :: … … 44 44 Content-Type: application/atom+xml; charset=utf-8 45 45 46 レスポンス本文 47 ------------- -46 Response Body 47 ------------- 48 48 49 XML 文書を返す。取得した件数分 entry 要素を格納する。 49 Returns XML Document. It has entries. 50 50 51 51 :: … … 54 54 <feed xmlns="http://www.w3.org/2005/Atom" 55 55 xmlns:openSearch="http://a9.com/-/spec/opensearchrss/1.0/"> 56 <title> 日記タイトル</title>56 <title>Diary</title> 57 57 <id>http://example.com/community/{community_id}</id> 58 58 <updated>2009-01-28T11:23:55+09:00</updated> … … 61 61 <link rel="alternate" type="text/html" href="http://example.com/diary"/> 62 62 <link rel="http://schemas.google.com/g/2005#feed" type="application/atom+xml" href="http://example.com/api.php/feeds/diary"/> 63 <openSearch:totalResults> 総件数</openSearch:totalResults>64 <openSearch:startIndex> 取得を開始したエントリの番号</openSearch:startIndex>65 <openSearch:itemsPerPage> 1ページあたりの件数</openSearch:itemsPerPage>63 <openSearch:totalResults>Maximum Number of Results</openSearch:totalResults> 64 <openSearch:startIndex>Starting Index of Entry</openSearch:startIndex> 65 <openSearch:itemsPerPage>Number of per a Page</openSearch:itemsPerPage> 66 66 <entry> 67 67 <id>http://example.com/diary/{diary_id}</id> 68 68 <published>2009-01-28T11:23:55+09:00</published> 69 69 <updated>2009-01-28T11:23:55+09:00</updated> 70 <title type="text"> 日記タイトル</title>71 <content type="text"> 日記本文</content>70 <title type="text">Title</title> 71 <content type="text">Body</content> 72 72 <author> 73 <name> 投稿したメンバーのニックネーム</name>73 <name>Nickname</name> 74 74 <uri>http://example.com/member/{member_id}</uri> 75 75 </author> … … 83 83 <published>2009-01-28T11:23:55+09:00</published> 84 84 <updated>2009-01-28T11:23:55+09:00</updated> 85 <title type="text"> 日記タイトル</title>86 <content type="text"> 日記本文</content>85 <title type="text">Title</title> 86 <content type="text">Body</content> 87 87 <author> 88 <name> 投稿したメンバーのニックネーム</name>88 <name>Nickname</name> 89 89 <uri>http://example.com/member/{member_id}</uri> 90 90 </author> -
OpenPNE3/doc/branches/develop/OpenPNEWebAPI/en/docs/diary_api/get_resource.rst
r12888 r12968 1 1 .. _diary_api_get_resource: 2 2 3 ================ ====4 日記::エントリの取得 5 ================ ====3 ================ 4 Diary::Get Entry 5 ================ 6 6 7 リクエスト 8 ======= ===7 Request 8 ======= 9 9 10 リクエストの方法 11 ---------------- 10 The Way to Request 11 ------------------ 12 12 13 メンバ URI に対して GET リクエストをおこなう。 13 Do GET to Member URI. 14 14 15 15 :: … … 18 18 Host: example.com 19 19 20 リクエストパラメータ 21 ----------------- ---20 Request Parameter 21 ----------------- 22 22 23 なし 23 None 24 24 25 レスポンス 26 ======== ==25 Response 26 ======== 27 27 28 レスポンスヘッダ 29 --------------- -28 Response Header 29 --------------- 30 30 31 HTTPステータスコード 200 を返す。 31 Returns HTTP Status Code 200. 32 32 33 33 :: … … 36 36 Content-Type: application/atom+xml; charset=utf-8 37 37 38 レスポンス本文 39 ------------- -38 Response Body 39 ------------- 40 40 41 XML 文書を返す。 41 Returns XML Document. 42 42 43 43 :: … … 48 48 <published>2009-01-25T19:40:22+09:00</published> 49 49 <updated>2009-01-25T19:40:22+09:00</updated> 50 <title type="text"> 日記タイトル</title>51 <content type="text"> 日記本文</content>50 <title type="text">Title</title> 51 <content type="text">Body</content> 52 52 <author> 53 <name> 投稿したメンバーのニックネーム</name>53 <name>Nickname of Author</name> 54 54 <uri>http://example.com/member/{member_id}</uri> 55 55 </author> -
OpenPNE3/doc/branches/develop/OpenPNEWebAPI/en/docs/diary_api/post_resource.rst
r12888 r12968 1 1 .. _diary_api_post_resource: 2 2 3 ================= ===4 日記::エントリの追加 5 ================= ===3 ================= 4 Diary::Post Entry 5 ================= 6 6 7 リクエスト 8 ======= ===7 Request 8 ======= 9 9 10 リクエストの方法 11 ---------------- 10 The Way to Request 11 ------------------ 12 12 13 コレクション URI に対して POST リクエストをおこなう。 13 Do POST to Collection URI. 14 14 15 15 16 :: … … 19 20 Content-Type: application/atom+xml; charset=utf-8 20 21 21 リクエストパラメータ 22 ----------------- ---22 Request Parameter 23 ----------------- 23 24 24 なし 25 None 25 26 26 リクエスト本文 27 ------------ --27 Request Body 28 ------------ 28 29 29 以下のサンプルに登場する要素をすべて含めた XML 文書である必要がある。 30 It must be a XML Document that contains all of element in the following example. 30 31 31 32 :: … … 33 34 <?xml version="1.0" encoding="UTF-8" ?> 34 35 <entry xmlns="http://www.w3.org/2005/Atom"> 35 <title type="text"> 日記タイトル</title>36 <content type="text"> 日記本文</content>36 <title type="text">Title</title> 37 <content type="text">Body</content> 37 38 <author> 38 <name> 投稿したメンバーのニックネーム</name>39 <name>Nickname</name> 39 40 <uri>http://example.com/member/{member_id}</uri> 40 41 </author> … … 42 43 43 44 44 レスポンス 45 ======== ==45 Response 46 ======== 46 47 47 レスポンスヘッダ 48 --------------- -48 Response Header 49 --------------- 49 50 50 HTTPステータスコード 201 を返す。 51 Returns HTTP Status Code 201. 51 52 52 Location ヘッダには、新しく作成されたリソースのメンバ URI が含まれる。 53 The Location Header contains Member URI for new resource. 53 54 54 55 :: … … 58 59 Content-Type: application/atom+xml; charset=utf-8 59 60 60 レスポンス本文 61 ------------- -61 Response Body 62 ------------- 62 63 63 XML 文書を返す。 64 Returns XML Document. 64 65 65 66 :: … … 70 71 <published>2009-01-25T19:40:22+09:00</published> 71 72 <updated>2009-01-25T19:40:22+09:00</updated> 72 <title type="text"> 日記タイトル</title>73 <content type="text"> 日記本文</content>73 <title type="text">Title</title> 74 <content type="text">Body</content> 74 75 <author> 75 <name> 投稿したメンバーのニックネーム</name>76 <name>Nickname of Author</name> 76 77 <uri>http://example.com/member/{member_id}</uri> 77 78 </author> -
OpenPNE3/doc/branches/develop/OpenPNEWebAPI/en/docs/diary_api/put_resource.rst
r12888 r12968 1 1 .. _diary_api_put_resource: 2 2 3 ================ ====4 日記::エントリの更新 5 ================ ====3 ================ 4 Diary::Put Entry 5 ================ 6 6 7 リクエスト 8 ======= ===7 Request 8 ======= 9 9 10 リクエストの方法 11 ---------------- 10 The Way to Request 11 ------------------ 12 12 13 メンバ URI に対して PUT リクエストをおこなう。 13 Do PUT to Member URI. 14 14 15 15 :: … … 19 19 Content-Type: application/atom+xml; charset=utf-8 20 20 21 リクエストパラメータ 22 ----------------- ---21 Request Parameter 22 ----------------- 23 23 24 なし 24 None 25 25 26 リクエスト本文 27 ------------ --26 Request Body 27 ------------ 28 28 29 以下のサンプルに登場する要素をすべて含めた XML 文書である必要がある。 29 It must be a XML Document that contains all of element in the following example. 30 30 31 31 :: … … 33 33 <?xml version="1.0" encoding="UTF-8" ?> 34 34 <entry xmlns="http://www.w3.org/2005/Atom"> 35 <title type="text"> 日記タイトル</title>36 <content type="text"> 日記本文</content>35 <title type="text">Title</title> 36 <content type="text">Body</content> 37 37 <author> 38 <name> 投稿したメンバーのニックネーム</name>38 <name>Nickname</name> 39 39 <uri>http://example.com/member/{member_id}</uri> 40 40 </author> 41 41 </entry> 42 42 43 レスポンス 44 ======== ==43 Response 44 ======== 45 45 46 レスポンスヘッダ 47 --------------- -46 Response Header 47 --------------- 48 48 49 HTTPステータスコード 200 を返す。 49 Returns HTTP Status Code 200. 50 50 51 51 :: … … 54 54 Content-Type: application/atom+xml; charset=utf-8 55 55 56 レスポンス本文 57 ------------- -56 Response Body 57 ------------- 58 58 59 XML 文書を返す。 59 Returns XML Document. 60 60 61 61 :: … … 66 66 <published>2009-01-25T19:40:22+09:00</published> 67 67 <updated>2009-01-25T19:40:22+09:00</updated> 68 <title type="text"> 日記タイトル</title>69 <content type="text"> 日記本文</content>68 <title type="text">Title</title> 69 <content type="text">Body</content> 70 70 <author> 71 <name> 投稿したメンバーのニックネーム</name>71 <name>Nickname of Author</name> 72 72 <uri>http://example.com/member/{member_id}</uri> 73 73 </author>
Note: See TracChangeset
for help on using the changeset viewer.