jersey+spring+swagger
2018-03-22 本文已影响0人
Richard_80ec
1 建立spring+jersey的项目,在此不赘述。
2 添加swagger-jersey的依赖包
<dependency>
<groupId>com.wordnik</groupId>
<artifactId>swagger-jersey-jaxrs_2.11</artifactId>
<version>1.3.12</version>
<exclusions><!--尽量移出jersey-core的依赖,避免冲突-->
<exclusion>
<groupId>com.sun.jersey</groupId>
<artifactId>jersey-core</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>javax.ws.rs</groupId>
<artifactId>jsr311-api</artifactId>
<version>1.1.1</version>
</dependency>
3 在web.xml文件中加入swagger的api文档的访问路径
<servlet>
<servlet-name>JerseyJaxrsConfig</servlet-name>
<servlet-class>com.wordnik.swagger.jersey.config.JerseyJaxrsConfig</servlet-class>
<init-param>
<param-name>api.version</param-name>
<param-value>1.0.0</param-value>
</init-param>
<init-param>
<param-name>swagger.api.basepath</param-name>
<param-value>http://localhost:8080/api/api-docs</param-value>
</init-param>
<load-on-startup>2</load-on-startup>
</servlet>
在web.xml添加servlet时,可能编译器会报出差servlet-mapping的警告,此警告可以忽略
4 启动项目,访问http://localhost:8080/api/api-docs即可查看到全部添加swagger注解的接口的介绍,如果想看到某个接口如:/hello的详细信息,则访问http://localhost:8080/api/api-docs/hello即可看到
具体代码见github:https://github.com/midlocke/jersey-spring-swagger.git