1、pox.xml
在pox.xml中添加内容:
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.6.1</version>
</dependency>
<!-- swagger-ui 为项目提供api展示及测试的界面 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.6.1</version>
</dependency>
<!-- 集成 swagger 的时候,缺少这个 jar3.包是不OK的-->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>${jackson.versioin}</version>
<exclusions>
<exclusion>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-core</artifactId>
</exclusion>
<exclusion>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-core</artifactId>
<version>${jackson.versioin}</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
<version>${jackson.versioin}</version>
</dependency>
2、web.xml
在web.xml中加入以下内容:
<servlet>
<servlet-name>dispacher-servlet</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:spring-mvc.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>dispacher-servlet</servlet-name>
<url-pattern>/swagger/*</url-pattern>
</servlet-mapping>
3、spring-mvc.xml
在spring-mvc.xml中加入(我们的程序代码位于com.nova下面):
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:context="http://www.springframework.org/schema/context" xmlns:p="http://www.springframework.org/schema/p"
xmlns:mvc="http://www.springframework.org/schema/mvc" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-3.2.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-3.2.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc-3.2.xsd">
<!-- 注解扫描包 -->
<context:component-scan base-package="com.nova.*" />
<!-- 开启mvc注解 -->
<mvc:annotation-driven ></mvc:annotation-driven>
<context:annotation-config></context:annotation-config>
<mvc:default-servlet-handler/>
<!-- 静态资源过滤 -->
<mvc:resources mapping="swagger-ui.html" location="classpath:/META-INF/resources/"/>
<mvc:resources mapping="/webjars/**" location="classpath:/META-INF/resources/webjars/"/>
<!-- JSP视图解析器-->
<bean id="viewResolver"
class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="prefix" value="/WEB-INF/views/"></property>
<property name="suffix" value=".jsp"></property>
<!-- prefix和suffix:查找视图页面的前缀和后缀(前缀[逻辑视图名]后缀),
比如传进来的逻辑视图名为hello,则该该jsp视图页面应该存放在“WEB-INF/views/hello.jsp” -->
</bean>
<bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter"></bean>
</beans>
4、添加swagger配置文件
package com.nova.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
* Created by SQL on 2019-01-07.
*/
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api(){
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build()
.apiInfo(MyApiInfo());
}
private ApiInfo MyApiInfo(){
return new ApiInfoBuilder()
.title("xxxx对外开放接口文档") //大标题
.description("HTTP对外接口") //小标题
.version("0.0.1") //版本
.termsOfServiceUrl("http://www.xxxx.com")
.license("LINCENSE")
.licenseUrl("http://xxx.xxx.com")
.build();
}
}
5、添加接口
package com.nova.controller;
import com.nova.model.Product;
import io.swagger.annotations.*;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
* Created by SQL on 2019-01-04.
*/
@RestController
@RequestMapping(value = {"/api"})
@Api(value = "/api",tags = "api")
@EnableSwagger2
public class ProductController {
@ApiOperation(value = "获取Name1",notes = "这就是一个获取name的测试")
@RequestMapping(value = "/GetByName/{name}",method = RequestMethod.GET)
//@ApiImplicitParams(@ApiImplicitParam(name = "name",value = "学生的名称",required = true,dataType = "String"))
public ResponseEntity<String> getName( @PathVariable("name") String name )
{
return ResponseEntity.ok( name + " SQL");
}
@ApiOperation(value = "测试下拉框")
@RequestMapping(value = "/TestSelect/{type}",method = RequestMethod.POST)
@ApiImplicitParams({
@ApiImplicitParam(name = "type",value = "类型",dataType = "String",paramType = "query", allowableValues = ",shi,zhang",required = true)
})
public ResponseEntity<String> SelectTest(String type){
return ResponseEntity.ok("Test "+type);
}
}
6、整个项目
7、配置tomcat,并启动