1:引入依赖
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency>
2:编写一个swagger 配置类
@Configuration @EnableWebMvc @EnableOpenApi public class SwaggerConfig { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.example.demotest.controller")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("程序猿xiaoxia API") .description("xiaoxia springboot-swagger2 在线借口文档") .termsOfServiceUrl("https://blog.csdn.net/XikYu") .version("1.0") .build(); } }
3:在controller层中填写一些注解
@RestController @RequestMapping("/department") @SuppressWarnings("all") //@RequiredArgsConstructor(onConstructor = @__(@Autowired)) public class DepartmentController { @Resource private DepartmentService departmentService; @PostMapping("treeDepartment") @ApiOperation(value = "树形化结构数据") public Result treeDepartment(){ List<Department> departmentAll = departmentService.findDepartmentAll(); return new Result(ResultCode.SUCCESS,departmentAll); } }
4:访问地址:http://localhost:8080/swagger-ui/index.html