qiitex v1.0.0 Qiitex.Api.Item
ユーザからの投稿を表します。
Link to this section Summary
Functions
新たに記事を作成します。
記事を削除します。
記事を取得します。
Qiita:TeamのいいねAPIは2017年8月24日に非推奨となりました。今後は絵文字リアクションAPIをご利用ください。 記事に「いいね！」を付けているかどうかを調べます。
記事をストックしているかどうかを調べます。
ユーザー名、日時を指定して記事を作成します。(Qiita:Teamでのみ有効。管理者権限が必要。)
Qiita:TeamのいいねAPIは2017年8月24日に非推奨となりました。今後は絵文字リアクションAPIをご利用ください。 記事に「いいね！」を付けます。
認証中のユーザの記事の一覧を作成日時の降順で返します。
記事の一覧を作成日時の降順で返します。
指定されたタグが付けられた記事一覧を、タグを付けた日時の降順で返します。
指定されたユーザの記事一覧を、作成日時の降順で返します。
指定されたユーザがストックした記事一覧を、ストックした日時の降順で返します。
記事をストックします。
Qiita:TeamのいいねAPIは2017年8月24日に非推奨となりました。今後は絵文字リアクションAPIをご利用ください。 記事への「いいね！」を取り消します。
記事をストックから取り除きます。
記事を更新します。
Link to this section Functions
create_item(client, params)
新たに記事を作成します。
POST /api/v2/items
body
- Markdown形式の本文
- example:
# Example - type:
string
coediting
optional- この記事が共同更新状態かどうか (Qiita:Teamでのみ有効)
- example:
false - type:
boolean
gist
optional- 本文中のコードをGistに投稿するかどうか (GitHub連携を有効化している場合のみ有効)
- example:
false - type:
boolean
group_url_name
optional- この投稿を公開するグループの url_name (null で全体に公開。Qiita:Teamでのみ有効)
- example:
dev - type:
["null","string"]
private
optional- 限定共有状態かどうかを表すフラグ (Qiita:Teamでは無効)
- example:
false - type:
boolean
tags
- 記事に付いたタグ一覧
- example:
[{"versions":["0.0.1"],"name":"Ruby"}] - type:
array
title
- 記事のタイトル
- example:
Example title - type:
string
tweet
optional- Twitterに投稿するかどうか (Twitter連携を有効化している場合のみ有効)
- example:
false - type:
boolean
delete_item(client, item_id)
記事を削除します。
DELETE /api/v2/items/:item_id
get_item(client, item_id)
記事を取得します。
GET /api/v2/items/:item_id
get_item_like(client, item_id)
Qiita:TeamのいいねAPIは2017年8月24日に非推奨となりました。今後は絵文字リアクションAPIをご利用ください。 記事に「いいね！」を付けているかどうかを調べます。
GET /api/v2/items/:item_id/like
get_item_stock(client, item_id)
記事をストックしているかどうかを調べます。
GET /api/v2/items/:item_id/stock
import_item(client, params)
ユーザー名、日時を指定して記事を作成します。(Qiita:Teamでのみ有効。管理者権限が必要。)
POST /api/v2/imported_items
body
- Markdown形式の本文
- example:
# Example - type:
string
coediting
optional- この記事が共同更新状態かどうか (Qiita:Teamでのみ有効)
- example:
false - type:
boolean
created_at
optional- データが作成された日時
- example:
2000-01-01T00:00:00+00:00 - format:
date-time - type:
string
group_url_name
optional- この投稿を公開するグループの url_name (null で全体に公開。Qiita:Teamでのみ有効)
- example:
dev - type:
["null","string"]
tags
- 記事に付いたタグ一覧
- example:
[{"versions":["0.0.1"],"name":"Ruby"}] - type:
array
title
- 記事のタイトル
- example:
Example title - type:
string
updated_at
optional- データが最後に更新された日時
- example:
2000-01-01T00:00:00+00:00 - format:
date-time - type:
string
user_id
- ユーザID
- example:
yaotti - type:
string
like_item(client, item_id)
Qiita:TeamのいいねAPIは2017年8月24日に非推奨となりました。今後は絵文字リアクションAPIをご利用ください。 記事に「いいね！」を付けます。
PUT /api/v2/items/:item_id/like
list_authenticated_user_items(client, options \\ %{})
認証中のユーザの記事の一覧を作成日時の降順で返します。
GET /api/v2/authenticated_user/items
page
optional- ページ番号 (1から100まで)
- example:
1 - pattern:
^[0-9]+$ - type:
string
per_page
optional- 1ページあたりに含まれる要素数 (1から100まで)
- example:
20 - pattern:
^[0-9]+$ - type:
string
list_items(client, options \\ %{})
記事の一覧を作成日時の降順で返します。
GET /api/v2/items
page
optional- ページ番号 (1から100まで)
- example:
1 - pattern:
^[0-9]+$ - type:
string
per_page
optional- 1ページあたりに含まれる要素数 (1から100まで)
- example:
20 - pattern:
^[0-9]+$ - type:
string
query
optional- 検索クエリ
- example:
qiita user:yaotti - type:
string
list_tag_items(client, tag_id, options \\ %{})
指定されたタグが付けられた記事一覧を、タグを付けた日時の降順で返します。
GET /api/v2/tags/:tag_id/items
page
optional- ページ番号 (1から100まで)
- example:
1 - pattern:
^[0-9]+$ - type:
string
per_page
optional- 1ページあたりに含まれる要素数 (1から100まで)
- example:
20 - pattern:
^[0-9]+$ - type:
string
list_user_items(client, user_id, options \\ %{})
指定されたユーザの記事一覧を、作成日時の降順で返します。
GET /api/v2/users/:user_id/items
page
optional- ページ番号 (1から100まで)
- example:
1 - pattern:
^[0-9]+$ - type:
string
per_page
optional- 1ページあたりに含まれる要素数 (1から100まで)
- example:
20 - pattern:
^[0-9]+$ - type:
string
list_user_stocks(client, user_id, options \\ %{})
指定されたユーザがストックした記事一覧を、ストックした日時の降順で返します。
GET /api/v2/users/:user_id/stocks
page
optional- ページ番号 (1から100まで)
- example:
1 - pattern:
^[0-9]+$ - type:
string
per_page
optional- 1ページあたりに含まれる要素数 (1から100まで)
- example:
20 - pattern:
^[0-9]+$ - type:
string
stock_item(client, item_id)
記事をストックします。
PUT /api/v2/items/:item_id/stock
unlike_item(client, item_id)
Qiita:TeamのいいねAPIは2017年8月24日に非推奨となりました。今後は絵文字リアクションAPIをご利用ください。 記事への「いいね！」を取り消します。
DELETE /api/v2/items/:item_id/like
unstock_item(client, item_id)
記事をストックから取り除きます。
DELETE /api/v2/items/:item_id/stock
update_item(client, item_id, params)
記事を更新します。
PATCH /api/v2/items/:item_id
body
- Markdown形式の本文
- example:
# Example - type:
string
coediting
optional- この記事が共同更新状態かどうか (Qiita:Teamでのみ有効)
- example:
false - type:
boolean
group_url_name
optional- この投稿を公開するグループの url_name (null で全体に公開。Qiita:Teamでのみ有効)
- example:
dev - type:
["null","string"]
private
optional- 限定共有状態かどうかを表すフラグ (Qiita:Teamでは無効)
- example:
false - type:
boolean
tags
optional- 記事に付いたタグ一覧
- example:
[{"versions":["0.0.1"],"name":"Ruby"}] - type:
array
title
- 記事のタイトル
- example:
Example title - type:
string