java web api接口开发实例.pdf

javawebapi接口开发实例

JavaWebAPI接口开发实例（一）

一、什么是API

API（ApplicationProgrammingInterface，应用程序编程接口），

是指软件系统不同组成部分之间的接口，是用来定义软件组件之间交

互的代码。API提供软件系统中的被调用组件定义的特定的参数，调

用方法及返回值。

API是计算机软件的实现技术，可以让用户从软件程序的某个控

件上，调用控件的功能函数，达到用户的特定目的。

二、JavaWebAPI开发实例

1、实例介绍

在本实例中，我们将使用Java实现一个简单的WebAPI，它可

以被其他应用程序调用，以便访问某个网站的某个页面的某一部分

（如摘要），从而获取某个网站的所有文章列表。

2、实例步骤

（1）新建一个eclipse工程，并创建一个Java类，名为

ArticleService。代码如下：

publicclassArticleService{

privatestaticfinalLoggerlog=

LoggerFactory.getLogger(ArticleService.class);

publicList<Article>getArticles(Stringurl)throws

Exception{

-1-
List<Article>articles=newArrayList<>();

try{

Documentdoc=Jsoup.connect(url).get();

Elementselements=doc.getElementsByTag('h2');

for(Elementelement:elements){

Articlearticle=newArticle();

Stringtitle=element.text();

article.setTitle(title);

articles.add(article);

}

}catch(IOExceptione){

log.error('ErrorgettingarticlesfromURL:{}',url,e);

throwe;

}

returnarticles;

}

}

（2）创建一个Article的类，用来保存文章的摘要。

publicclassArticle{

privateStringtitle;

//getter&setter

}

-2-
（3）添加API调用接口

在ArticleService类中添加一个新的方法，用于处理WebAPI

的调用：

publicArticleResponsegetArticlesAsJson(Stringurl)

throwsException{

ArticleResponseresponse=newArticleResponse();

try{

List<Article>articles=getArticles(url);

response.setArticles(articles);

response.setStatus('OK');

}catch(IOExceptione){

log.error('ErrorgettingarticlesfromURL:{}',url,e);

response.setStatus('ERROR');

response.setErrorMessage(e.getMessage());

}

returnresponse;

}

（4）创建ArticleResponse类，用来返回服务调用的结果：

publicclassArticleResponse{

privateStringstatus;

privateList<Article>articles;

privateStringerrorMessage;

-3-
//getter&setter

}

本文介绍的是如何使用Java开发WebAPI的实例，相信大家已

经清楚的看懂了，如果您想学习JavaWebAPI开发的话，可以参照

以上步骤，自己尝试着开发一个API，这样也可以更加深刻地理解Web

API是如何工作的。

-4-