为什么80%的码农都做不了架构师>>> 
最近公司一个新项目开发团队分布在不同的国度加拿大团队负责网站前端开发国内团队负责后台服务端开发前端和后端需要进行数据交互和对接这就少不了使用REST编写API接口这种场景两个开发小组之间就需要已规范的文档作为标准和协作基础。对于Jersey和swagger我以前并未了解过在最近的学习过程中也发现这方面的中文文档也不是很多英文不好于是把我最近学习到的整理分享给大家一来给后面学习的博友们做个参考二来也方便自己以后查阅。废话不多说先介绍下如何使用Jersey构建RESTful Web服务。
REST是Roy Fielding 2000年在博士论文中提出的。需要注意的是REST是设计风格不是标准。REST中最重要的概念就是资源Resources使用URL定位到唯一资源对于资源的创建、删除、修改和获取CRUD正好对应HTTP协议提供的POST、DELETE、PUT和GET方法。首先我们需要做到一点将所有REST请求发送到Jersey容器中那么我们在web.xml中定义一个servlet调度程序清单如下
pom.xml
org.glassfish.jersey.extjersey-spring32.5.1org.springframeworkspring-coreorg.springframeworkspring-weborg.springframeworkspring-beansorg.glassfish.jersey.mediajersey-media-json-jackson2.5.1com.wordnikswagger-jersey-jaxrs_2.101.3.2com.sun.jerseyjersey-clientcom.sun.jerseyjersey-corecom.sun.jerseyjersey-servercom.sun.jerseyjersey-servletcom.sun.jerseyjersey-multipart
一、 jersey配置
jersey-serlvetorg.glassfish.jersey.servlet.ServletContainerjavax.ws.rs.Applicationcom.yourcompany.service.rs.RestJaxRsApplicationjersey.config.server.provider.packagescom.yourcompany.service.rs.resources;com.wordnik.swagger.jaxrs.listing1
二、swagger配置
Jersey2Configcom.wordnik.swagger.jersey.config.JerseyJaxrsConfigapi.version1.0.0swagger.api.basepathhttp://localhost:8080/apijersey-serlvet/api/*
RestJaxRsApplication类
public class RestJaxRsApplication extends ResourceConfig{public RestJaxRsApplication(){register(ProductResource.class);register(RequestContextFilter.class);register(CORSResponseFilter.class);register(JacksonFeature.class);}}
ProductResource类
/*** 产品资源服务API*/ComponentPath("/products")Api(value "/products", description "core product")public class ProductResource {Autowiredprivate ProductDAO productDAO;POSTConsumes({MediaType.APPLICATION_JSON})Produces({MediaType.TEXT_HTML})ApiOperation(value "create product", notes "More notes about this method", response String.class, httpMethod "POST")ApiResponses(value {ApiResponse(code 400, message "Invalid ID supplied"),ApiResponse(code 404, message "Product not found")})public Response createProduct(Product product) {//TODO createreturn Response.status(Response.Status.CREATED).build();}GETProduces({MediaType.APPLICATION_JSON})ApiOperation(value "Find product by ID", notes "More notes about this method", response Product.class, httpMethod "GET")ApiResponses(value {ApiResponse(code 400, message "Invalid ID supplied"),ApiResponse(code 404, message "Product not found")})public Response getProduct(ApiParam(value "Resource identifier", required false) QueryParam("id") Integer id) {if(id null){//TODO getAllreturn Response.status(Response.Status.NO_CONTENT).allow("OPTIONS").build();}else {//TODO getByIdreturn Response.status(Response.Status.NO_CONTENT).allow("OPTIONS").build();}}PUTConsumes({MediaType.APPLICATION_JSON})Produces({MediaType.TEXT_HTML})ApiOperation(value "update product", notes "More notes about this method", response String.class, httpMethod "PUT")ApiResponses(value {ApiResponse(code 404, message "Product not found")})public Response updateProduct(Product product) {//TODO updatereturn Response.status(Response.Status.OK).build();}DELETEProduces({MediaType.TEXT_HTML})ApiOperation(value "remove product by ID", notes "More notes about this method", response String.class, httpMethod "DELETE")ApiResponses(value {ApiResponse(code 404, message "Product not found")})public Response removeProductById(ApiParam(value "ID values must", required true)QueryParam("id") Integer id) {//TODO removereturn Response.status(Response.Status.OK).build();}}
启动访问http://localhost:8080/api/api-docs 即可看到所有RESTful接口apis列表查看单个接口及加上path即可。
配置swagger-ui
下载swagger-ui相关库https://github.com/swagger-api/swagger-ui将dist目录下所有拷贝到项目webapp目录下修改dist目录中index.html页面中的url。
启动服务器访问http://localhost:8080/swagger-ui/index.html 看到如下界面就恭喜你了
测试的话看到页面就懂了非常简单。
关于jersey和swagger的注解配置说明在下篇博客整理。
转:https://my.oschina.net/fuyung/blog/343374
【文章出处:滨海网页开发公司 http://www.1234xp.com/binhai.html 欢迎留下您的宝贵建议】