zblog做API接口（zblog开发教程）

今天给各位分享zblog做API接口的知识，其中也会对zblog开发教程进行解释，如果能碰巧解决你现在面临的问题，别忘了关注本站，现在开始吧！

本文目录一览：

• 1、zblog php 地图插件怎么用
• 2、如何重构出这么优雅后台 API 接口
• 3、如何开发自己的API接口？
• 4、怎么为自己的网站编写api接口
• 5、Z-Blog博客系统 怎么用 详细
• 6、如何对外开放api接口 csdn

zblog php 地图插件怎么用

1.说明

插件采用系统提供的各种接口，用来实现一些高级定制功能，让Z-BlogPHP变的更加强壮和有趣(Very Good,Very Strong.)。

2.目录及命名要求

插件是放在系统的zb_users/plugin目录下的，插件必须有自己的目录名且不与其它插件同名。

插件目录名即是插件的ID名称，系统也以此做为识别。

插件必须设定正确的plugin.xml文件，系统依赖此文件对插件进行管理。

plugin.xml文件里的”id“节点一定要设定为插件的ID名称(即插件的目录名称)，这非常重要。

3.plugin.xml格式规范说明

1.样例文档

?xml version="1.0" encoding="utf-8"?

plugin version="php"

idTotoro/id

nameTotoro/name

url /url

note基于TotoroII的Z-Blog的评论及引用管理审核系统增强版。/note

description/description

pathmain.php/path

includeinclude.php/include

level1/level

author

namezsx/name

email /email

url /url

/author

source

name/name

email/email

url/url

/source

adapted130707/adapted

version1.0/version

pubdate2013-07-07/pubdate

modified2013-09-02/modified

price0/price

advanced

dependency/dependency

rewritefunctions/rewritefunctions

conflict/conflict

/advanced

sidebars

sidebar1/sidebar1

sidebar2/sidebar2

sidebar3/sidebar3

sidebar4/sidebar4

sidebar5/sidebar5

/sidebars

/plugin

如何重构出这么优雅后台 API 接口

Hello，早上好，我是阿粉~

最近偶然间在看到 Spring 官方文档的时候，新学到一个注解 @ControllerAdvice ，并且成功使用这个注解重构我们项目的对外 API 接口，去除繁琐的重复代码，使其开发更加优雅。

展示具体重构代码之前，我们先来看下原先对外 API 接口是如何开发的。

这个 API 接口主要是用来与我们 APP 交互，这个过程我们统一定义一个交互协议，APP 端与后台 API 接口统一都使用 JSON 格式。

另外后台 API 接口对 APP 返回时，统一一些错误码，APP 端需要根据相应错误码，在页面弹出一些提示。

下面展示一个查询用户信息返回的接口数据：

code 代表对外的错误码， msg 代表错误信息， result 代表具体返回信息。

前端 APP 获取这个返回信息，首先判断接口返回 code 是否为 「000000」 ，如果是代表查询成功，然后获取 result 信息作出相应的展示。否则，直接弹出相应的错误信息。

下面我们来看下，重构之前的，后台 API 层的如何编码。

上面的代码其实很简单，内部统一封装了一个工具类 APIResult ，然后用其包装具体的结果。

除了这个以外，还定义一个异常对象 APPException ，用来统一包装内部的各种异常。

上面的代码很简单，但是呢可以说比较繁琐，重复代码也比较多，每个接口都需要使用 try...catch 包装，然后使用 APIResult 包括正常的返回信息与错误信息。

第二呢，接口对象只能返回 APIResult ，真实业务对象只能隐藏在 APIResult 中。这样不太优雅，另外不能很直观知道真实业务对象。

下面我们开始重构上面的代码，主要目的是去除重复的那一坨 try...catch 代码。

这次重构我们需要使用Spring 注解 @ControllerAdvice 以及 ResponseBodyAdvice ，我们先来看下重构的代码。

首先我们需要实现 ResponseBodyAdvice ，实现我们自己的处理类。

实现上面的接口，我们就可以在 beforeBodyWrite 方法里，修改返回结果了。

上面代码中，只是简单使用 APIResult 包装了返回结果，然后返回。其实我们还可以在此增加一些额外逻辑，比如说如接口返回信息由加密的需求，我们可以在这一层统一加密。

另外，这里判断一下 body 是否 APIResult 类，如果是就直接返回，不做修改。

这么做一来兼容之前的老接口，这是因为默认情况下，我们自己实现的 CustomResponseAdvice 类，将会对所有的 Controller 生效。

如果不做判断，以前的老接返回就会被包装了两层 APIResul ,影响 APP 解析。

除此之外，如果大家担心这个修改对以前的老接口有影响的话，可以使用下面的方式，只对指定的方法生效。

首先自定义一个注解，比如说：

然后将其标注在需要改动的方法中，然后我们在 ResponseBodyAdvice#supports 中判断具体方法上有没有自定义注解 CustomResponse ，如果存在，返回 true ，这就代表最后将会修改返回类。如果不存在，则返回 false ，那么就会跟以前流程一样。

上面的代码重构之后，将重复代码抽取了出来，整体的代码就剩下我们的业务逻辑，这样就变得非常简洁优雅。

不过，上面的重构的代码，还是存在问题，主要是异常的处理。

如果上面的业务代码抛出了异常，那么接口将会返回堆栈错误信息，而不是我们定义的错误信息。所以下面我们这个，再次优化一下。

这次我们主要需要使用 @ExceptionHandler 注解，这个注解需要与 @ControllerAdvice 一起使用。

使用这个 @ExceptionHandler ，将会拦截相应的异常，然后将会调用的相应方法处理异常。这里我们就使用 APIResult 包装一些错误信息返回。

我们可以使用 @ControllerAdvice 加 ResponseBodyAdvice 拦截返回结果，统一做出一些修改。这样就可以使用的业务代码非常简洁，优雅。

另外，针对业务代码的中，我们可以使用 @ExceptionHandler 注解，统一做一个全局异常处理，这样就可以无缝的跟 ResponseBodyAdvice 结合。

不过这里需要一点，我们实现的 ResponseBodyAdvice 类，一定需要跟 @ControllerAdvice 配合一起使用哦，至于具体原因，下篇文章阿粉分析原来的时候，再具体解释哦。敬请期待哦~

如何开发自己的API接口？

开发自己的api需要准备几个工作：

第一：提高你的API的功能

第二：设置你的API访问协议，如：socket,http

第三：升级你的API的认证方式,如：curl,oauth

第四：找到属于你的API开发语言

怎么为自己的网站编写api接口

80%的都用webservice 新浪微博API（java版） ============================ 修改事项： 1、接口返回结果采用json对象方式封装 2、修改WeiboResponse中空字符串("")调用判断的bug 3、修改了JSONObject中返回空对象的问题 4、增加了直接文件上传接口直接 常用接口实例： （使用前先修改 Weibo.java 中 public static final String CONSUMER_KEY = ""; public static final String CONSUMER_SECRET = ""; 填写成实际申请的 CONSUMER_KEY 及 CONSUMER_SECRET） 1、获取最新公共微博列表 参考：weibo4j.examples.GetTimelines 中的getPublicTimeline()部分 2、发表微博 参考：weibo4j.examples.Update 中的updateStatus(...)部分 3、发表评论 参考：weibo4j.examples.Update 中的updateComment(...)部分 4、删除评论 参考：weibo4j.examples.Update 中的destroyComment(...)部分 5、发送私人消息 参考：weibo4j.examples.DirectMessage 类 6、发表带图片的微博 参考：weibo4j.examples.OAuthUploadByFile 中的uploadStatus(status,file)部分 7、更新用户头像 参考：weibo4j.examples.OAuthUpdateProfile类 8、OAuth桌面应用访问 步骤： 1 在weibo4j.examples.OAuthUpdate 访问认证的URL，得到pin 2 在weibo4j.examples.OAuthUpdate 输入pin，然后得到AccessToken 3 即可访问用户的微博，参考：weibo4j.examples.OAuthUpdateTwo 9、OAuth WEB应用访问 步骤： 1 在weibo4j.examples.WebOAuth 带backurl参数请求OAuth认证，获得RequestToken 2 在callback 的地址里面，接受到oauth_verifier参数，然后再发一次请求，即可获得AccessToken 3 用AccessToken访问用户的微博 实例说明： 在web目录下面有两个jsp页面： call.jsp 是发送request的请求，在第九行的参数“”是回调地址 当获取成功后将RequestToken置入session，并重定向到用户认证地址 callback.jsp 接收到oauth_verifier参数，从session里面拿到RequestToken，再请求获取AccessToken 获取到后即可对用户微博进行操作，本例中是发表微博 测试环境： 本例中可以将call.jsp和 callback.jsp直接放到tomcat的根目录下面：webapps\ROOT 并将实例项目编译好的classes文件和lib目录拷贝到ROOT\WEB-INF下面 重启tomcat，访问 注：也可以打成war包，但注意call.jsp里面的callback参数需要做相应修改 ============================================================================= 其他接口在weibo4j.Weibo类中定义，调用方式请参考weibo4j.examples，下面是完整的接口列表： 获取下行数据集(timeline)接口 方法名： statuses/public_timeline 最新公共微博 方法名：getPublicTimeline statuses/friends_timeline 最新关注人微博 (别名: statuses/home_timeline) 方法名：getFriendsTimeline statuses/user_timeline 用户发表微博列表 方法名：getUserTimeline(String id, Paging paging) statuses/mentions 最新 @用户的 方法名： getMentions() statuses/comments 单条评论列表(按微博) 方法名：getComments() 微博访问接口 statuses/show 获取单条 方法名：showStatus(long id) statuses/update 发表微博 方法名：updateStatus(String status) statuses/upload 发表微博及图片 方法名：uploadStatus(String status,File file) statuses/destroy 删除 方法名： destroyStatus(long statusId) statuses/comment 评论 方法名： destroyComment(long commentId) statuses/comment_destroy 删除评论 方法名：destroyComment 私信接口 direct_messages 我的私信列表 方法名：getDirectMessages() 分页 getDirectMessages(Paging paging) direct_messages/sent 我发送的私信列表 方法名：getSentDirectMessages() direct_messages/new 发送私信 方法名：sendDirectMessage(String id,String text) direct_messages/destroy 删除一条私信 方法名：destroyDirectMessage(int id) 关注接口 friendships/create 关注某用户 方法名：createFriendship(String id)或 createFriendship(String id, boolean follow) friendships/destroy 取消关注 方法名： destroyFriendship(String id) friendships/exists 是否关注某用户 方法名：existsFriendship(String userA, String userB) friends/ids 关注列表 方法名： getFriendsIDs(long cursor) followers/ids 粉丝列表 方法名：getFollowersIDs(long cursor) 账号接口 account/verify_credentials 验证身份是否合法 方法名：verifyCredentials() account/rate_limit_status 查看当前频率限制 方法名：rateLimitStatus() account/update_profile_image 更改头像 方法名：updateProfileImage(File image) account/update_profile 更改资料 方法名：User updateProfile(String name, String email, String url, String location, String description) 收藏接口 favorites 收藏列表 方法名：getFavorites() favorites/create 添加收藏 方法名：createFavorite(long id) favorites/destroy 删除收藏 方法名：destroyFavorite(long id)

采纳哦

Z-Blog博客系统 怎么用 详细

Z-Blog 1.7 使用手册

系统配置:

服务器：Windows 2000及IIS5.0以上，需要ADO数据库、FSO、XMLDOM等系统组件支持和空间的读写权限，具体请查询网络服务商或查看本机配置。

客户端：支持Mozilla FireFox 1.0、IE6.0、Opear 8.0及更高版本的浏览器。客户端浏览器需要启用JavaScript脚本支持。

安装说明:

如果用的是手动安装包,上传所有文件后,在浏览器中打开博客地址将自动转到初次安装的向导页.

如果用的是自动安装包,上传仅有的两个文件后,在浏览器中打开 ,其中指的是你的博客地址,像这样: ,程序会引导你完成几个简单的安装步骤.

进入向导页也仅需完成4项内容:

1.BLOG的网络地址(自动读取)

2.数据库的名称和地址(系统自动随机生成)

3.博客管理员账号(用户名与密码)

4.BLOG唯一标识符(系统自动随机生成)

实际上,在这一步中,只要设置好你的管理员账号就行了,其它三项都由程序自动生成的.

点击提交,整个安装过程就完成了,Good Luck To You!

如果你的域名更换或想把数据库移至其它目录,请参考使用说明中的"如何手动配置BLOG程序?"条目,以更新配置.

另外,在程序后台"用户管理"中,管理员可以创建比自己权限低的账号，推荐建立一个“高级用户”供日常使用。

升级说明:

使用1.2-1.6beta版本的用户，将数据库放入1.7版程序的DATA目录中，在设置完c_custom.asp里的ZC_DATABASE_PATH参数和ZC_BLOG_HOST参数后，使用以前的账号登入后台管理界面，在[备份与更新]栏使用[数据库升级]功能，让旧版的数据库升级为最新版的数据库结构，再将需要保留的附件、样式等放入相应的目录即完成了升级。1.6 Final版本的用户不用升级数据库，只修改ZC_DATABASE_PATH参数和ZC_BLOG_HOST参数。

使用说明:

1.如何手动配置BLOG程序?

当域名变更或其它原因需要手动配置BLOG程序，参照此法：

请先将c_custom.asp文件中的 ZC_BLOG_HOST 更改为已分配的IP或域名。

格式一定要是""，前面要加 http://' ,后面要加上 '/' 。

将DATA目录下的数据库改为一个非常复杂的名称。

再更改 ZC_DATABASE_PATH 值为 "data/你的数据库名称" ，数据库升级只能放在DATA目录下(你可以在升级后更改路径)。

数据库中默认的管理员账号和密码均为zblogger。

2.在[网站设置]中更改你的BLOG名称等等，也包括更换CSS界面样式等各种配置。

在设置完成之后请点[文件重建]或[索引重建]以让更改后的配置生效。

3.首次使用,请先在[分类管理]建立一个分类，再到[文章管理]中添加新日志文章。

管理员和高级用户有分类创建或删除的权限。

4.可选用UBB编辑器或是可视编辑器新建和修改日志。

在文章提交完成之后再次编辑该文件才能向对方的BLOG发送引用。

最好请自行提取正文的文字做为摘要，系统的自动截断功能有可能会使列表页显示不正常。

5.什么时候需要点击[索引重建]？

[索引重建]让系统刷新缓存和统计数据，同时，生成该BLOG的RSS 2.0和Atom 1.0聚合的XML文件于根目录中。

每次发表文章、修改分类等操作后需要点击[索引重建]。

6.什么时候需要点击[文件重建]？

当你在[网站设置]更改了相应的设置，都需要使用“文件重建”以使每个文章页面更改生效。

“文件重建”是一个消耗资源与时间的事件，尤其是BLOG中日志数量众多时。

7.如何减轻服务器压力进行[文件重建]？

在“网站设置”中将"单次重建文件数目"设置为10-20个左右，

将"单次重建文件后的间隔秒数"设置为5-10秒左右，

再进行[文件重建]，就会将一个很长的过程分解为有时间间隔的小段重建过程。

8.关于“导航栏”、“友情链接”等条目请在在后台进入[文件管理]页面直接修改源文件。

它们的格式都是：

lia href="" target="_blank"布罗格的烘培机/a/li

也可在INCLUDE目录中修改相应文件的HTML代码。

9.如何让日志显示源代码，包括HTML，ASP，PHP代码等，请用“[ CODE ] [/ CODE ]”(固定文本区域)

或“[CODE_LITE] [/CODE_LITE]”将源程序包含就行了。

UBB代码请参考这里的介绍:;extra=page%3D1

10.附件都上传在UPLOAD目录中，只能上传限定类型的文件。

请用IE或FireFox上传全ASCII字符名称的文件。

在[网站设置]中可以设置上传文件的种类和大小限制。

11.如何在日志中引用附件呢？

编辑状态下上传附件将自动插入相应代码。以下格式，系统会自动将相对路径替代成绝对路径。

a href="upload/abc.zip" alt="xxx" title="xxx"xxx/a

img src="upload/abc.jpg" alt="xx" title="xxx" width="xx" height="xx" /

[ URL=]abc.jpg[/URL] 或 [URL=upload/abc.jpg]abc.jpg[/URL]

12.如何在一个站点(域名)内使用两个及以上的Z-Blog程序？

进入后台[网站设置]页，将ZC_BLOG_CLSID设置为不同的值即可。

由于程序自身的限制，Z-Blog不支持多域名共同指向同一个BLOG。

13.Z-Blog的XML-RPC功能如何使用？

Z-Blog的XML-RPC接口采用MetaWeblog的API，可以在相应软件和网站调用该接口。

相应的XMP-RPC接口URL为: ,在你的博客后台首页可以看到该地址.

14.如何应对SPAM的侵扰？

每隔一段时间（几个月或更长）在后台设置中更改一次ZC_BLOG_CLSID的值，然后进行[文件重建]。在网站设置里还可以关闭评论和引用。或是采用第三方的插件以达到此目的。

15.请保管好你的管理员账号与密码。

Z-Blog提供对管理员账号开放权限的服务器文件修改功能，这个功能非常强大但也异常危险，所以请你务必小心保管你的管理员的账号，防止他人对你网站的全面侵入。

如何对外开放api接口 csdn

标识为的接口为高级接口，需要申请才可以调用，申请方式请见高级接口申请

标识为的接口为开放接口，不需要用户授权就可以调用

用户接口

user/getemail 获取用户的邮箱

user/getinfo 获取用户基本资料

user/getmobile 获取用户的手机

user/getavatar 批量获取用户的头像

博客接口

blog/getinfo 获取博主基本信息

blog/getstats 获取博主的统计信息

blog/getmedal 获取博主的勋章

blog/getcolumn 获取博主的专栏

blog/getarticlelist 获取博主的文章列表

blog/getarticle 获取文章内容

blog/getcategorylist 获取博主的自定义分类

blog/gettaglist 获取博主使用过的的标签

blog/getcommentlist 获取博主收到的评论

blog/getmycommentlist 获取博主发出的评论

blog/getarticlecomment 获取文章的评论

blog/saveinfo 修改博主信息

blog/savearticle 发表/修改文章

blog/postcomment 发表评论

blog/getnewarticlelist 获取博客最新文章

blog/gethomenewest 获取首页最新文章

blog/getexpertlist 获取博客专家

blog/getcolumnlist 获取专栏列表

blog/getcolumndetails 获取专栏信息

blog/getcolumnarticles 获取专栏的文章

blog/getchannel 获取博客系统分类

论坛接口

bbs/gettopics 获取板块最新帖子列表

bbs/gettopicdetails 获取帖子详细内容

bbs/posttopic 发布帖子

bbs/postreply 回复帖子

bbs/getreplies 获取回复列表

bbs/getreplyusers

zblog做API接口的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于zblog开发教程、zblog做API接口的信息别忘了在本站进行查找喔。