1.引入jar包
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
2.配置swagger2
//使用@Configuration添加配置信息
@Configuration
public class Swagger2 {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.csl.recruit")) //使用swagger的包名
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("招聘模块")
.description("企业api和招聘api")
.version("1.0")
.build();
}
}
3.开启swagger
@SpringBootApplication
@EnableSwagger2 //开启swagger
public class RecruitApplication {
public static void main(String[] args) {
SpringApplication.run(RecruitApplication.class, args);
}
}
4.使用
控制类controller中
@Api(tags = "企业api") //controller的名字
@RestController
@RequestMapping("/enterprise")
public class EnterpriseController {
@Autowired
private IEnterpriseService enterpriseService;
@ApiOperation(value = "获取全部企业") //api的含义
@GetMapping
public Result<List> findAll(){
return null;
}
}
实体类中
@Entity
@Table(name="tb_enterprise")
public class Enterprise {
@ApiModelProperty(value = "企业id")
@Id
private String id;
@ApiModelProperty(value = "企业名") //字段的含义
private String name;
}
5.结果
在浏览器输入http://ip:port/swagger-ui.html#/,得到swagger界面。可以在其中直接使用接口。