From e80ee742e8710f3b578e1e546c0b64f054fd83e3 Mon Sep 17 00:00:00 2001 From: "rui.zhang" Date: Sat, 22 Dec 2018 21:05:05 +0800 Subject: [PATCH] edit doc Change-Id: I2ec270156f26b4a1887c6549b74a6a83f51fa222 --- README.md | 6 +++++- pom.xml | 2 +- src/main/java/org/chobit/wp/enums/PostTaxonomy.java | 10 +++++++++- .../java/org/chobit/wp/model/interval/Enclosure.java | 4 ++++ .../java/org/chobit/wp/model/request/PostFilter.java | 3 +++ .../java/org/chobit/wp/model/request/PostRequest.java | 3 +++ src/main/java/org/chobit/wp/model/request/Request.java | 3 +++ src/main/java/org/chobit/wp/model/response/Author.java | 3 +++ .../java/org/chobit/wp/model/response/MediaItem.java | 3 +++ src/main/java/org/chobit/wp/model/response/Post.java | 3 +++ src/main/java/org/chobit/wp/model/response/Term.java | 3 +++ 11 files changed, 40 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5ea7461..0d54db3 100644 --- a/README.md +++ b/README.md @@ -96,7 +96,7 @@ getAuthors()方法返回的是用户相关的信息： PostRequest post = new PostRequest(); post.setPostTitle("测试Title"); post.setPostContent("这是一段测试文章内容"); - post.setCategories("测试"); + post.setCategories("分类1","分类2"); post.setTags("a", "b", "c"); post.setPostName("test-post-name"); int postId = wp.newPost(post); @@ -105,6 +105,10 @@ getAuthors()方法返回的是用户相关的信息： 这里需要注意postName和postTitle。postTitle指的是文章标题；postName指的则是文章别名，主要在文章的url路径中使用。通常建议将postName设置为英文字符。 +setCategories设置的是文章分类，要求设置的分类在博客中必须已经存在，且名称需要一致。 + +setTags设置的是文章标签，不要求在博客中已经存在。 + 更多发布文章的参数可以参考[XML-RPC WordPress API/Posts - newPost](https://codex.wordpress.org/XML-RPC_WordPress_API/Posts#wp.newPost)文档描述。 ## 获取文章 diff --git a/pom.xml b/pom.xml index d1649cb..168a31a 100644 --- a/pom.xml +++ b/pom.xml @@ -12,7 +12,7 @@ org.chobit.wp wordpress-client - 0.1.1 + 0.1.2 jar WordPress-Client diff --git a/src/main/java/org/chobit/wp/enums/PostTaxonomy.java b/src/main/java/org/chobit/wp/enums/PostTaxonomy.java index 2add808..5662ec7 100644 --- a/src/main/java/org/chobit/wp/enums/PostTaxonomy.java +++ b/src/main/java/org/chobit/wp/enums/PostTaxonomy.java @@ -1,9 +1,17 @@ package org.chobit.wp.enums; +/** + * @author robin + */ public enum PostTaxonomy { - + /** + * 文章分类 + */ CATEGORY("category"), + /** + * 文章标签 + */ TAG("post_tag"), ; public final String taxonomy; diff --git a/src/main/java/org/chobit/wp/model/interval/Enclosure.java b/src/main/java/org/chobit/wp/model/interval/Enclosure.java index cbf5924..48d210b 100644 --- a/src/main/java/org/chobit/wp/model/interval/Enclosure.java +++ b/src/main/java/org/chobit/wp/model/interval/Enclosure.java @@ -1,5 +1,9 @@ package org.chobit.wp.model.interval; + +/** + * @author robin + */ public class Enclosure { private String url; diff --git a/src/main/java/org/chobit/wp/model/request/PostFilter.java b/src/main/java/org/chobit/wp/model/request/PostFilter.java index 07c08e3..a11fcd2 100644 --- a/src/main/java/org/chobit/wp/model/request/PostFilter.java +++ b/src/main/java/org/chobit/wp/model/request/PostFilter.java @@ -3,6 +3,9 @@ package org.chobit.wp.model.request; import com.fasterxml.jackson.annotation.JsonProperty; +/** + * @author robin + */ public class PostFilter extends Request { @JsonProperty("post_type") diff --git a/src/main/java/org/chobit/wp/model/request/PostRequest.java b/src/main/java/org/chobit/wp/model/request/PostRequest.java index f4b203a..6991d7d 100644 --- a/src/main/java/org/chobit/wp/model/request/PostRequest.java +++ b/src/main/java/org/chobit/wp/model/request/PostRequest.java @@ -13,6 +13,9 @@ import java.util.Map; import static org.chobit.wp.enums.PostTaxonomy.CATEGORY; import static org.chobit.wp.enums.PostTaxonomy.TAG; +/** + * @author robin + */ public class PostRequest extends Request { public PostRequest() { diff --git a/src/main/java/org/chobit/wp/model/request/Request.java b/src/main/java/org/chobit/wp/model/request/Request.java index 597853b..6689c66 100644 --- a/src/main/java/org/chobit/wp/model/request/Request.java +++ b/src/main/java/org/chobit/wp/model/request/Request.java @@ -9,6 +9,9 @@ import java.util.Map; import static org.chobit.wp.tools.JsonKit.fromJson; import static org.chobit.wp.tools.JsonKit.toJson; +/** + * @author robin + */ public abstract class Request { public Map toMap() throws IOException { diff --git a/src/main/java/org/chobit/wp/model/response/Author.java b/src/main/java/org/chobit/wp/model/response/Author.java index 6f68abe..fdb25ba 100644 --- a/src/main/java/org/chobit/wp/model/response/Author.java +++ b/src/main/java/org/chobit/wp/model/response/Author.java @@ -3,6 +3,9 @@ package org.chobit.wp.model.response; import com.fasterxml.jackson.annotation.JsonProperty; +/** + * @author robin + */ public class Author { @JsonProperty("user_id") diff --git a/src/main/java/org/chobit/wp/model/response/MediaItem.java b/src/main/java/org/chobit/wp/model/response/MediaItem.java index 4c692fe..ccea05b 100644 --- a/src/main/java/org/chobit/wp/model/response/MediaItem.java +++ b/src/main/java/org/chobit/wp/model/response/MediaItem.java @@ -5,6 +5,9 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Date; +/** + * @author robin + */ public class MediaItem { @JsonProperty("attachment_id") diff --git a/src/main/java/org/chobit/wp/model/response/Post.java b/src/main/java/org/chobit/wp/model/response/Post.java index bb80467..be3e3d7 100644 --- a/src/main/java/org/chobit/wp/model/response/Post.java +++ b/src/main/java/org/chobit/wp/model/response/Post.java @@ -6,6 +6,9 @@ import org.chobit.wp.model.interval.Enclosure; import java.util.Date; import java.util.List; +/** + * @author robin + */ public class Post { @JsonProperty("post_id") diff --git a/src/main/java/org/chobit/wp/model/response/Term.java b/src/main/java/org/chobit/wp/model/response/Term.java index 137f98c..dba472d 100644 --- a/src/main/java/org/chobit/wp/model/response/Term.java +++ b/src/main/java/org/chobit/wp/model/response/Term.java @@ -3,6 +3,9 @@ package org.chobit.wp.model.response; import com.fasterxml.jackson.annotation.JsonProperty; +/** + * @author robin + */ public class Term {