|
1 |
| -#Qiita4j |
2 |
| -[Qiita API](http://qiita.com/docs "Qiita API document") の Java ラッパーライブラリです。 |
| 1 | +#Qiita4j |
| 2 | +[Qiita API](http://qiita.com/docs "Qiita API document") の Java ラッパーライブラリです。 |
3 | 3 | ## トークンの取得
|
4 |
| -`QiitaClient client = new QiitaClient();` |
5 |
| -`TokenInfo tokenInfo = client.authorize(new AuthRequest(<ユーザー名>, <パスワード>));` |
6 |
| -`System.out.println(tokenInfo.getToken());` |
| 4 | + QiitaClient client = new QiitaClient(); |
| 5 | + TokenInfo tokenInfo = client.authorize(new AuthRequest(<ユーザー名>, <パスワード>)); |
| 6 | + System.out.println(tokenInfo.getToken()); |
7 | 7 | ## トークンの設定
|
8 |
| -`QiitaClient client = new QiitaClient(<トークン>);` |
| 8 | + QiitaClient client = new QiitaClient(<トークン>); |
9 | 9 | または
|
10 |
| -`QiitaClient client = new QiitaClient();` |
11 |
| -`client.setToken(<トークン>);` |
| 10 | + |
| 11 | + QiitaClient client = new QiitaClient(); |
| 12 | + client.setToken(<トークン>); |
12 | 13 | ## Qiita API の実行
|
13 | 14 | QiitaClient のメソッドを使用して実行します。
|
14 | 15 | ### 残りリクエスト可能数とRate Limit取得
|
15 |
| -`RateLimit rateLimit = client.getRateLimit();` |
| 16 | + RateLimit rateLimit = client.getRateLimit(); |
16 | 17 | ### リクエストユーザーの情報取得
|
17 |
| -`UserInfo ownInfo = client.getOwnInfo();` |
| 18 | + UserInfo ownInfo = client.getOwnInfo(); |
18 | 19 | ### 特定ユーザーの情報取得
|
19 |
| -`UserInfo userInfo = client.getUserInfo(<ユーザー名>);` |
| 20 | + UserInfo userInfo = client.getUserInfo(<ユーザー名>); |
20 | 21 | ### 特定ユーザーの投稿取得
|
21 |
| -`PageableResponse<ItemInfo> userItemsPage = client.getUserItems(<ユーザー名>);` |
22 |
| -`ItemInfo[] userItems = userItemsPage.getContents();` |
| 22 | + PageableResponse<ItemInfo> userItemsPage = client.getUserItems(<ユーザー名>); |
| 23 | + ItemInfo[] userItems = userItemsPage.getContents(); |
23 | 24 | ### 特定ユーザーのストックした投稿取得
|
24 |
| -`PageableResponse<ItemInfo> userStockItemsPage = client.getUserStocks(<ユーザー名>);` |
25 |
| -`ItemInfo[] userStockItems = userStockItemsPage.getContents();` |
| 25 | + PageableResponse<ItemInfo> userStockItemsPage = client.getUserStocks(<ユーザー名>); |
| 26 | + ItemInfo[] userStockItems = userStockItemsPage.getContents(); |
26 | 27 | ### 特定ユーザーのフォローしているユーザー取得
|
27 |
| -`PageableResponse<User> followingUsersPage = client.getFollowingUsers(<ユーザー名>);` |
28 |
| -`User[] followingUsers = followingUsersPage.getContents();` |
| 28 | + PageableResponse<User> followingUsersPage = client.getFollowingUsers(<ユーザー名>); |
| 29 | + User[] followingUsers = followingUsersPage.getContents(); |
29 | 30 | ### 特定ユーザーのフォローしているタグ取得
|
30 |
| -`PageableResponse<TagInfo> followingTagsPage = client.getFollowingTags(<ユーザー名>);` |
31 |
| -`TagInfo[] followingTags = followingTagsPage.getContents();` |
| 31 | + PageableResponse<TagInfo> followingTagsPage = client.getFollowingTags(<ユーザー名>); |
| 32 | + TagInfo[] followingTags = followingTagsPage.getContents(); |
32 | 33 | ### 特定タグの投稿取得
|
33 |
| -`PageableResponse<ItemInfo> tagItemsPage = client.getTagItems(<タグ名>);` |
34 |
| -`ItemInfo[] tagItems = tagItemsPage.getContents();` |
| 34 | + PageableResponse<ItemInfo> tagItemsPage = client.getTagItems(<タグ名>); |
| 35 | + ItemInfo[] tagItems = tagItemsPage.getContents(); |
35 | 36 | ### タグ一覧取得
|
36 |
| -`PageableResponse<TagInfo> tagsPage = client.getTags();` |
37 |
| -`TagInfo[] tags = tagsPage.getContents();` |
| 37 | + PageableResponse<TagInfo> tagsPage = client.getTags(); |
| 38 | + TagInfo[] tags = tagsPage.getContents(); |
38 | 39 | ### 検索結果取得
|
39 |
| -`PageableResponse<ItemInfo> searchResultItemsPage = client.searchItems(new SearchRequest(<検索文字列(複数指定可)>));` |
40 |
| -`ItemInfo[] searchResultItems = searchResultItemsPage.getContents();` |
| 40 | + PageableResponse<ItemInfo> searchResultItemsPage = client.searchItems(new SearchRequest(<検索文字列(複数指定可)>)); |
| 41 | + ItemInfo[] searchResultItems = searchResultItemsPage.getContents(); |
41 | 42 | ### 新着投稿の取得
|
42 |
| -`PageableResponse<ItemInfo> newItemsPage = client.getNewItems();` |
43 |
| -`ItemInfo[] newItems = newItemsPage.getContents();` |
| 43 | + PageableResponse<ItemInfo> newItemsPage = client.getNewItems(); |
| 44 | + ItemInfo[] newItems = newItemsPage.getContents(); |
44 | 45 | ### 自分のストックした投稿の取得
|
45 |
| -`PageableResponse<ItemInfo> ownStockItemsPage = client.getOwnStocks();` |
46 |
| -`ItemInfo[] ownStockItems = ownStockItemsPage.getContents();` |
| 46 | + PageableResponse<ItemInfo> ownStockItemsPage = client.getOwnStocks(); |
| 47 | + ItemInfo[] ownStockItems = ownStockItemsPage.getContents(); |
47 | 48 | ### 投稿の実行
|
48 |
| -`ItemRequest createItem = new ItemRequest();` |
49 |
| -`ItemInfo createResult = client.createItem(createItem);` |
| 49 | + ItemRequest createItem = new ItemRequest(); |
| 50 | + ItemInfo createResult = client.createItem(createItem); |
50 | 51 | ### 投稿の更新
|
51 |
| -`ItemRequest updateItem = new ItemRequest();` |
52 |
| -`ItemInfo updateResult = client.updateItem(<UUID>, updateItem);` |
| 52 | + ItemRequest updateItem = new ItemRequest(); |
| 53 | + ItemInfo updateResult = client.updateItem(<UUID>, updateItem); |
53 | 54 | ### 投稿の削除
|
54 |
| -`client.deleteItem(<UUID>);` |
| 55 | + client.deleteItem(<UUID>); |
55 | 56 | ### 特定の投稿取得
|
56 |
| -`ItemDetail detail = client.getSpecificItem(<UUID>);` |
| 57 | + ItemDetail detail = client.getSpecificItem(<UUID>); |
57 | 58 | ### 投稿のストック
|
58 |
| -`client.stockItem(<UUID>);` |
| 59 | + client.stockItem(<UUID>); |
59 | 60 | ### 投稿のストック解除
|
60 |
| -`client.unstockItem(<UUID>);` |
| 61 | + client.unstockItem(<UUID>); |
61 | 62 | ## ページネーション
|
62 | 63 | ### 取得件数の指定
|
63 |
| -`client.setPerPage(50);` |
| 64 | + client.setPerPage(50); |
64 | 65 | ### ページング
|
65 |
| -`PageableResponse<ItemInfo> userItemsPage = client.getUserItems(<ユーザー名>);` |
| 66 | + PageableResponse<ItemInfo> userItemsPage = client.getUserItems(<ユーザー名>); |
| 67 | + |
| 68 | + PageableResponse<ItemInfo> firstPage = userItemsPage.getFirst(); |
| 69 | + ItemInfo[] firstItems = firstPage.getContents(); |
66 | 70 |
|
67 |
| -`PageableResponse<ItemInfo> firstPage = userItemsPage.getFirst();` |
68 |
| -`ItemInfo[] firstItems = firstPage.getContents();` |
| 71 | + PageableResponse<ItemInfo> prevPage = userItemsPage.getPrev(); |
| 72 | + ItemInfo[] prevItems = prevPage.getContents(); |
69 | 73 |
|
70 |
| -`PageableResponse<ItemInfo> prevPage = userItemsPage.getPrev();` |
71 |
| -`ItemInfo[] prevItems = prevPage.getContents();` |
| 74 | + PageableResponse<ItemInfo> nextPage = userItemsPage.getNext(); |
| 75 | + ItemInfo[] nextItems = nextPage.getContents(); |
72 | 76 |
|
73 |
| -`PageableResponse<ItemInfo> nextPage = userItemsPage.getNext();` |
74 |
| -`ItemInfo[] nextItems = nextPage.getContents();` |
| 77 | + PageableResponse<ItemInfo> lastPage = userItemsPage.getLast(); |
| 78 | + ItemInfo[] lastItems = lastPage.getContents(); |
| 79 | +## Maven Repository |
| 80 | + <repositories> |
| 81 | + <repository> |
| 82 | + <id>com.zaneli</id> |
| 83 | + <name>Zaneli Repository</name> |
| 84 | + <url>http://www.zaneli.com/repositories/snapshots/</url> |
| 85 | + </repository> |
| 86 | + </repositories> |
75 | 87 |
|
76 |
| -`PageableResponse<ItemInfo> lastPage = userItemsPage.getLast();` |
77 |
| -`ItemInfo[] lastItems = lastPage.getContents();` |
| 88 | + <dependencies> |
| 89 | + <dependency> |
| 90 | + <groupId>com.zaneli</groupId> |
| 91 | + <artifactId>qiita4j</artifactId> |
| 92 | + <version>0.0.1-SNAPSHOT</version> |
| 93 | + </dependency> |
| 94 | + </dependencies> |
0 commit comments