SpringBoot13-集成swagger接口api助手

亦凉 2022-04-25 09:10 180阅读 0赞

# 第一步：引入依赖 #

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

# 第二步：编写一个配置类进行swagger的配置 #

@Configuration
    @EnableSwagger2
    public class SwaggerConfig {
    
        @Bean
    
        public Docket createRestApi() {
    
            return new Docket(DocumentationType.SWAGGER_2)
    
                    .apiInfo(apiInfo())
    
                    .select()
    
                    .apis(RequestHandlerSelectors.basePackage("com.ctbu"))// 指定扫描包下面的注解
    
                    .paths(PathSelectors.any())
    
                    .build();
    
        }
    
        // 创建api的基本信息
    
        private ApiInfo apiInfo() {
    
            return new ApiInfoBuilder()
    
                    .title("集成Swagger2构建RESTful APIs")
    
                    .description("集成Swagger2构建RESTful APIs")
    
                    .termsOfServiceUrl("https://www.baidu.com")
    
                    .contact("xiaopu")
    
                    .version("1.0.0")
    
                    .build();
    
        }
    
    }

# 第三步;在需要生成api的方法上写上相应的注解 #

@RequestMapping("hello")
        @ResponseBody
        @ApiOperation(value="查询操作",notes="查询所有的英雄信息",httpMethod="GET")
        public List<Hero> getAllHero(){
            List<Hero> allHero = heroService.getAllHero();
            for (Hero hero : allHero) {
                System.out.println(hero );
            }
            return allHero;
        }

# 第四步：启动服务器并直接访问swagger的ui界面 #

端口号根据自己的来

http://localhost:8080/swagger-ui.html#

结果展示

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MTk4NDY3_size_16_color_FFFFFF_t_70][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MTk4NDY3_size_16_color_FFFFFF_t_70]: /images/20220125/02f7413f158e408ebff4e065738ad8d4.png