13518219792
我们知道API其实就是应用程序编程接口，可以把它理解为是一种通道，用来和不同软件系统间进行通信，本质上它是预先定义的函数。API有很多种形式，最为常见的就是以HTTP协议来提供服务（如：RESTful），只要符合规范就可正常使用。现在各类企业在信息化这块都会用到第三方提供的API，也会提供API给第三方调用，因此设计API也是需要慎重的。
创新互联坚持“要么做到，要么别承诺”的工作理念，服务领域包括：成都网站建设、成都做网站、企业官网、英文网站、手机端网站、网站推广等服务，满足客户于互联网时代的城中网站设计、移动媒体设计的需求，帮助企业找到有效的互联网解决方案。努力成为您成熟可靠的网络建设合作伙伴！
具体该如何开发设计一个良好的API接口呢？
明确功能
在设计之初就需要将API详细功能整理出来，按业务功能点或模块来划分，明确此API需要提供哪些功能。
代码逻辑清晰
保持代码整洁性，增加必要的注释，接口确保功能单一，如果一个接口需要复杂的业务逻辑，建议拆分成多个接口或者将功能独立封装成公共方法，避免接口里代码过多，不利于后期人员维护和后期迭代。
必要的安全校验机制
目前Web应用很容易遭遇数据窃取、篡改、非法提交、重复请求等安全问题，API的安全校验机制是必不可少的。常用解决方案就是采用数字签名形式，将每个HTTP请求都加上签名，服务器端校验签名合法性来保证请求是否合法。
日志记录
为便于及时定位问题，日志是必不可少的。
降低耦合度
一个良好的API应该是越简单越好，如果API间业务耦合度过高很容易因某块代码异常导致相关API的不可用，尽可能避免API间的复杂调用关系。
返回有意义的状态码
API返回数据中要携带状态码数据，比如200代表请求正常，500代表服务器内部错误等。返回通用的状态码有利于问题定位，比如可参考以下状态码：
开发文档
既然API是提供给第三方或内部使用的，那开发文档是必不可少的，否则他人不知道如何调用。一个良好的API开发文档应包含以下元素：
1、当前API架构模式讲解、开发工具及版本、系统依懒等环境信息；
2、当前API提供哪些功能；
3、API模块间的依懒关系；
4、调用规则、注意事项；
5、部署注意事项等。
一个好的API必然是易使用，易看懂，易扩展，难误用，安全性高，功能强大的API。要做到上面几点并不容易，但是我们应当遵从上述原则结合业务本身合理的划分设计API
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提供对管理员账号开放权限的服务器文件修改功能，这个功能非常强大但也异常危险，所以请你务必小心保管你的管理员的账号，防止他人对你网站的全面侵入。
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)
采纳哦
API(Application Programming Interface,应用程序编程接口)是一套用来控制Windows的各个部件(从桌面的外观到为一个新进程分配的内存)的外观和行为的一套预先定义的Windows函数.用户的每个动作都会引发一个或几个函数的运行以告诉Windows发生了什么.
这在某种程度上很象Windows的天然代码.其他的语言只是提供一种能自动而且更容易的访问API的方法.VB在这方面作了很多工作.它完全隐藏了API并且提供了在Windows环境下编程的一种完全不同的方法. 这也就是说,你用VB写出的每行代码都会被VB转换为API函数传递给Windows.例如,Form1.Print...VB 将会以一定的参数(你的代码中提供的,或是默认参数)调用TextOut 这个API函数. 。同样,当你点击窗体上的一个按钮时,Windows会发送一个消息给窗体(这对于你来说是隐藏的),VB获取这个调用并经过分析后生成一个特定事件(Button_Click).
API函数包含在Windows系统目录下的动态连接库文件中(如User32.dll,GDI32.dll,Shell32.dll...).
API 声明
正如在"什么是API"中所说,API函数包含在位于系统目录下的DLL文件中.你可以自己输入API函数的声明,但VB提供了一种更简单的方法,即使用API Text Viewer. 要想在你的工程中声明API函数,只需运行API Text Viewer,打开Win32api.txt(或.MDB如果你已经把它转换成了数据库的话,这样可以加快速度.注:微软的这个文件有很多的不足,你可以试一下本站提供下载的api32.txt),选择"声明",找到所需函数,点击"添加(Add)"并"复制(Copy)",然后粘贴(Paste)到你的工程里.使用预定义的常量和类型也是同样的方法.
你将会遇到一些问题:
假设你想在你的窗体模块中声明一个函数.粘贴然后运行,VB会告诉你:编译错误...Declare 语句不允许作为类或对象模块中的 Public 成员...看起来很糟糕,其实你需要做的只是在声明前面添加一个Private(如 Private Declare Function...).--不要忘了,可是这将使该函数只在该窗体模块可用. 在有些情况下,你会得到"不明确的名称"这样的提示,这是因为函数.常量或其他的什么东西共用了一个名称.由于绝大多数的函数(也可能是全部,我没有验证过)都进行了别名化,亦即意味着你可以通过Alias子句使用其它的而不是他们原有的名称,你只需简单地改变一下函数名称而它仍然可以正常运行.
API 分为四种类型：
远程过程调用（RPC）：通过作用在共享数据缓存器上的过程（或任务）实现程序间的通信。
标准查询语言（SQL）：是标准的访问数据的查询语言，通过通用数据库实现应用程序间的数据共享。
文件传输：文件传输通过发送格式化文件实现应用程序间数据共享。
信息交付：指松耦合或紧耦合应用程序间的小型格式化信息，通过程序间的直接通信实现数据共享。
当前应用于 API 的标准包括 ANSI 标准 SQL API。另外还有一些应用于其它类型的标准尚在制定之中。API 可以应用于所有计算机平台和操作系统。这些 API 以不同的格式连接数据（如共享数据缓存器、数据库结构、文件框架）。每种数据格式要求以不同的数据命令和参数实现正确的数据通信，但同时也会产生不同类型的错误。因此，除了具备执行数据共享任务所需的知识以外，这些类型的 API 还必须解决很多网络参数问题和可能的差错条件，即每个应用程序都必须清楚自身是否有强大的性能支持程序间通信。相反由于这种 API 只处理一种信息格式，所以该情形下的信息交付 API 只提供较小的命令、网络参数以及差错条件子集。正因为如此，交付 API 方式大大降低了系统复杂性，所以当应用程序需要通过多个平台实现数据共享时，采用信息交付 API 类型是比较理想的选择。
API 与图形用户接口（GUI）或命令接口有着鲜明的差别：
API 接口属于一种操作系统或程序接口，而后两者都属于直接用户接口。 有时公司会将 API 作为其公共开放系统。也就是说，公司制定自己的系统接口标准，当需要执行系统整合、自定义和程序应用等操作时，公司所有成员都可以通过该接口标准调用源代码，该接口标准被称之为开放式 API。
