Spring boot 中使用swagger-ui实现 restful-api

淩亂°似流年 2022-07-11 10:30 173阅读 0赞

步骤一：在pom文件中添加如下依赖

<dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.5.0</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.5.0</version>
    </dependency>

步骤二：新建一个类，添加Configuration注解

@Configuration
    @EnableSwagger2
    public class Swagger2 {
    
        @Bean
        public Docket createRestApi() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("com.eweiche"))
                    .paths(PathSelectors.any())
                    .build();
        }
    
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder().title("仓库管理API服务").description("更多电动车配件信息,请关注：http://eweiche.com/").termsOfServiceUrl("no terms of service")
                    .version("1.0")
                    .build();
        }
    
    }

步骤三：新建Controller

@RestController
    @RequestMapping(value = "/city")
    public class CityController {
        @Autowired
        private CityManager cityManager;
    
        @ApiOperation(value = "获取省份列表", notes = "获取省份列表")
        @GetMapping(value = "/province")
        public  ResponseData queryProvince(){
            List<Province> list =  cityManager.queryProvince();
            if (list!=null){
                return new ResponseData(true, SupplyEnums.SUCCESS,list);
            }
            return  new ResponseData(false,SupplyEnums.FAIL);
        }

步骤四：测试，浏览器中输入，网址 http://localhost:8083/swagger-ui.html#! 8083是我的服务端口，自行修改为 自己的端口号，集成完毕。