Web API v1 : comments - sosomasox/commpost-api GitHub Wiki

コメントの取得

下記に示すエンドポイントに対してGETメソッドを送ることで投稿された全てのコメントを取得することができる

エンドポイントのリソースパラメータである "_id" を指定することで特定のコメントを取得することができる

エンドポイントに対してクエリパラメータである "article_id" を付与してリクエストを送ることで対応する記事に対して投稿された全てのコメントを取得することができる

エンドポイントの形式

GET https://commpost.on-going.jp/api/v1/comments
GET https://commpost.on-going.jp/api/v1/comments/id/[_id]
GET https://commpost.on-going.jp/api/v1/comments?article_id=XXXXXXXXXXXXXXXXXXXX

リソースパラメータ	必須	説明
_id	省略可	コメントにつけられている固有のID

クエリパラメータ	説明
article_id	記事につけられている固有のID

リクエストの例

説明 投稿された全てのコメントを返す

GET https://commpost.on-going.jp/api/v1/comments

レスポンスの例

[
  {
    "_id": "5f23a447acf80d00061228f4",
    "date": "2020-07-31T04:55:35.118Z",
    "article_id": "e2be5aaa0ae44e507d4d8cd36adc4981935a8534f3ef37ec3827f1bfeb62c59a",
    "article_url": "https://commpost.on-going.jp/",
    "poster_name": "Tester",
    "text": "Test",
    "__v": 0
  },
  {
    "_id": "5f23a740acf80d00061228f5",
    "date": "2020-07-31T05:08:16.473Z",
    "article_id": "e2be5aaa0ae44e507d4d8cd36adc4981935a8534f3ef37ec3827f1bfeb62c59a",
    "article_url": "https://commpost.on-going.jp/",
    "poster_name": "Anonymous",
    "text": "This is test.",
    "__v": 0
  },
  {
    "_id": "5f23a76cacf80d00061228f6",
    "date": "2020-07-31T05:09:00.331Z",
    "article_id": "e2be5aaa0ae44e507d4d8cd36adc4981935a8534f3ef37ec3827f1bfeb62c59a",
    "article_url": "https://commpost.on-going.jp/",
    "poster_name": "Anonymous",
    "text": "Good article!",
    "__v": 0
  }
]

リクエストの例

説明 リソースパラメータである "_id" によって指定された特定のコメントを返す

GET https://commpost.on-going.jp/api/v1/comments/id/5f23a447acf80d00061228f4

レスポンスの例

{
  "_id": "5f23a447acf80d00061228f4",
  "date": "2020-07-31T04:55:35.118Z",
  "article_id": "e2be5aaa0ae44e507d4d8cd36adc4981935a8534f3ef37ec3827f1bfeb62c59a",
  "article_url": "https://commpost.on-going.jp/",
  "poster_name": "Tester",
  "text": "Test",
  "__v": 0
}

リクエストの例

説明 クエリパラメータである "article_id" に対応する記事に対して投稿された全てのコメントを返す

GET https://commpost.on-going.jp/api/v1/comments?article_id=e2be5aaa0ae44e507d4d8cd36adc4981935a8534f3ef37ec3827f1bfeb62c59a

レスポンスの例

[
  {
    "_id": "5f23a447acf80d00061228f4",
    "date": "2020-07-31T04:55:35.118Z",
    "article_id": "e2be5aaa0ae44e507d4d8cd36adc4981935a8534f3ef37ec3827f1bfeb62c59a",
    "article_url": "https://commpost.on-going.jp/",    
    "poster_name": "Tester",
    "text": "Test",
    "__v": 0
  },
  {
    "_id": "5f23a740acf80d00061228f5",
    "date": "2020-07-31T05:08:16.473Z",
    "article_id": "e2be5aaa0ae44e507d4d8cd36adc4981935a8534f3ef37ec3827f1bfeb62c59a",
    "article_url": "https://commpost.on-going.jp/",
    "poster_name": "Anonymous",
    "text": "This is test.",
    "__v": 0
  }
]

 

コメントの投稿

下記に示すエンドポイントに対してPOSTメソッドを送ることでコメントを投稿することができる

エンドポイントの形式

POST https://commpost.on-going.jp/api/v1/comments

リクエストパラメータ	必須	説明
article_id	必須	記事につけられている固有のID
article_url	必須	記事のURL
poster_name	必須	投稿者の名前
text	必須	コメントの内容
date	省略可	投稿した時刻

リクエストボディの例

{
  "article_id": "e2be5aaa0ae44e507d4d8cd36adc4981935a8534f3ef37ec3827f1bfeb62c59a",
  "article_url": "https://commpost.on-going.jp/",
  "poster_name": "Tester",
  "text": "Test"
}

 

コメントの更新

下記に示すエンドポイントに対してPUTメソッドを送ることで "_id" パラメータによって指定された特定のコメントを更新することができる

エンドポイントの形式

PUT https://commpost.on-going.jp/api/v1/comments/id/[_id]

リソースパラメータ	必須	説明
_id	省略可	コメントにつけられている固有のID

リクエストパラメータ	必須	説明
article_id	必須	記事につけられている固有のID
article_url	必須	記事のURL
poster_name	必須	投稿者の名前
text	必須	コメントの内容
date	省略可	投稿した時刻

リクエストボディの例

{
  "article_id": "e2be5aaa0ae44e507d4d8cd36adc4981935a8534f3ef37ec3827f1bfeb62c59a",
  "article_url": "https://commpost.on-going.jp/",
  "poster_name": "TESTER",
  "text": "TEST"
}

 

コメントの削除

下記に示すエンドポイントに対してDELETEメソッドを送ることで "_id" パラメータによって指定された特定のコメントを削除することができる

エンドポイントの形式

DELETE https://commpost.on-going.jp/api/v1/comments/id/[_id]

リソースパラメータ	必須	説明
_id	必須	コメントにつけられている固有のID