Skip to content

Commit 954657a

Browse files
committed
write in more detail about maven repository
1 parent 1227011 commit 954657a

File tree

2 files changed

+90
-48
lines changed

2 files changed

+90
-48
lines changed

README.md

Lines changed: 64 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,94 @@
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 ラッパーライブラリです。
33
## トークンの取得
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());
77
## トークンの設定
8-
`QiitaClient client = new QiitaClient(<トークン>);`
8+
QiitaClient client = new QiitaClient(<トークン>);
99
または
10-
`QiitaClient client = new QiitaClient();`
11-
`client.setToken(<トークン>);`
10+
11+
QiitaClient client = new QiitaClient();
12+
client.setToken(<トークン>);
1213
## Qiita API の実行
1314
QiitaClient のメソッドを使用して実行します。
1415
### 残りリクエスト可能数とRate Limit取得
15-
`RateLimit rateLimit = client.getRateLimit();`
16+
RateLimit rateLimit = client.getRateLimit();
1617
### リクエストユーザーの情報取得
17-
`UserInfo ownInfo = client.getOwnInfo();`
18+
UserInfo ownInfo = client.getOwnInfo();
1819
### 特定ユーザーの情報取得
19-
`UserInfo userInfo = client.getUserInfo(<ユーザー名>);`
20+
UserInfo userInfo = client.getUserInfo(<ユーザー名>);
2021
### 特定ユーザーの投稿取得
21-
`PageableResponse<ItemInfo> userItemsPage = client.getUserItems(<ユーザー名>);`
22-
`ItemInfo[] userItems = userItemsPage.getContents();`
22+
PageableResponse<ItemInfo> userItemsPage = client.getUserItems(<ユーザー名>);
23+
ItemInfo[] userItems = userItemsPage.getContents();
2324
### 特定ユーザーのストックした投稿取得
24-
`PageableResponse<ItemInfo> userStockItemsPage = client.getUserStocks(<ユーザー名>);`
25-
`ItemInfo[] userStockItems = userStockItemsPage.getContents();`
25+
PageableResponse<ItemInfo> userStockItemsPage = client.getUserStocks(<ユーザー名>);
26+
ItemInfo[] userStockItems = userStockItemsPage.getContents();
2627
### 特定ユーザーのフォローしているユーザー取得
27-
`PageableResponse<User> followingUsersPage = client.getFollowingUsers(<ユーザー名>);`
28-
`User[] followingUsers = followingUsersPage.getContents();`
28+
PageableResponse<User> followingUsersPage = client.getFollowingUsers(<ユーザー名>);
29+
User[] followingUsers = followingUsersPage.getContents();
2930
### 特定ユーザーのフォローしているタグ取得
30-
`PageableResponse<TagInfo> followingTagsPage = client.getFollowingTags(<ユーザー名>);`
31-
`TagInfo[] followingTags = followingTagsPage.getContents();`
31+
PageableResponse<TagInfo> followingTagsPage = client.getFollowingTags(<ユーザー名>);
32+
TagInfo[] followingTags = followingTagsPage.getContents();
3233
### 特定タグの投稿取得
33-
`PageableResponse<ItemInfo> tagItemsPage = client.getTagItems(<タグ名>);`
34-
`ItemInfo[] tagItems = tagItemsPage.getContents();`
34+
PageableResponse<ItemInfo> tagItemsPage = client.getTagItems(<タグ名>);
35+
ItemInfo[] tagItems = tagItemsPage.getContents();
3536
### タグ一覧取得
36-
`PageableResponse<TagInfo> tagsPage = client.getTags();`
37-
`TagInfo[] tags = tagsPage.getContents();`
37+
PageableResponse<TagInfo> tagsPage = client.getTags();
38+
TagInfo[] tags = tagsPage.getContents();
3839
### 検索結果取得
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();
4142
### 新着投稿の取得
42-
`PageableResponse<ItemInfo> newItemsPage = client.getNewItems();`
43-
`ItemInfo[] newItems = newItemsPage.getContents();`
43+
PageableResponse<ItemInfo> newItemsPage = client.getNewItems();
44+
ItemInfo[] newItems = newItemsPage.getContents();
4445
### 自分のストックした投稿の取得
45-
`PageableResponse<ItemInfo> ownStockItemsPage = client.getOwnStocks();`
46-
`ItemInfo[] ownStockItems = ownStockItemsPage.getContents();`
46+
PageableResponse<ItemInfo> ownStockItemsPage = client.getOwnStocks();
47+
ItemInfo[] ownStockItems = ownStockItemsPage.getContents();
4748
### 投稿の実行
48-
`ItemRequest createItem = new ItemRequest();`
49-
`ItemInfo createResult = client.createItem(createItem);`
49+
ItemRequest createItem = new ItemRequest();
50+
ItemInfo createResult = client.createItem(createItem);
5051
### 投稿の更新
51-
`ItemRequest updateItem = new ItemRequest();`
52-
`ItemInfo updateResult = client.updateItem(<UUID>, updateItem);`
52+
ItemRequest updateItem = new ItemRequest();
53+
ItemInfo updateResult = client.updateItem(<UUID>, updateItem);
5354
### 投稿の削除
54-
`client.deleteItem(<UUID>);`
55+
client.deleteItem(<UUID>);
5556
### 特定の投稿取得
56-
`ItemDetail detail = client.getSpecificItem(<UUID>);`
57+
ItemDetail detail = client.getSpecificItem(<UUID>);
5758
### 投稿のストック
58-
`client.stockItem(<UUID>);`
59+
client.stockItem(<UUID>);
5960
### 投稿のストック解除
60-
`client.unstockItem(<UUID>);`
61+
client.unstockItem(<UUID>);
6162
## ページネーション
6263
### 取得件数の指定
63-
`client.setPerPage(50);`
64+
client.setPerPage(50);
6465
### ページング
65-
`PageableResponse<ItemInfo> userItemsPage = client.getUserItems(<ユーザー名>);`
66+
PageableResponse<ItemInfo> userItemsPage = client.getUserItems(<ユーザー名>);
67+
68+
PageableResponse<ItemInfo> firstPage = userItemsPage.getFirst();
69+
ItemInfo[] firstItems = firstPage.getContents();
6670

67-
`PageableResponse<ItemInfo> firstPage = userItemsPage.getFirst();`
68-
`ItemInfo[] firstItems = firstPage.getContents();`
71+
PageableResponse<ItemInfo> prevPage = userItemsPage.getPrev();
72+
ItemInfo[] prevItems = prevPage.getContents();
6973

70-
`PageableResponse<ItemInfo> prevPage = userItemsPage.getPrev();`
71-
`ItemInfo[] prevItems = prevPage.getContents();`
74+
PageableResponse<ItemInfo> nextPage = userItemsPage.getNext();
75+
ItemInfo[] nextItems = nextPage.getContents();
7276

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>
7587

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>

pom.xml

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,39 @@
1111
<url>http://www.zaneli.com/</url>
1212

1313
<properties>
14-
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
14+
<encoding>UTF-8</encoding>
15+
<project.build.sourceEncoding>${encoding}</project.build.sourceEncoding>
16+
<sourceJavaVersion>1.7</sourceJavaVersion>
17+
<targetJavaVersion>1.7</targetJavaVersion>
1518
<httpcomponents.version>4.2</httpcomponents.version>
1619
<jsonic.version>1.2.11</jsonic.version>
1720
<commons-lang3.version>3.1</commons-lang3.version>
1821
<jmockit.version>0.999.4</jmockit.version>
1922
<junit.version>4.10</junit.version>
2023
</properties>
2124

25+
<build>
26+
<plugins>
27+
<plugin>
28+
<groupId>org.apache.maven.plugins</groupId>
29+
<artifactId>maven-compiler-plugin</artifactId>
30+
<configuration>
31+
<encoding>${encoding}</encoding>
32+
<source>${sourceJavaVersion}</source>
33+
<target>${targetJavaVersion}</target>
34+
</configuration>
35+
</plugin>
36+
</plugins>
37+
</build>
38+
39+
<distributionManagement>
40+
<repository>
41+
<id>com.zaneli</id>
42+
<name>Zaneli Repository</name>
43+
<url>${repository.url}</url>
44+
</repository>
45+
</distributionManagement>
46+
2247
<dependencies>
2348
<dependency>
2449
<groupId>org.apache.httpcomponents</groupId>

0 commit comments

Comments
 (0)