接口文档框架-swagger使用

た入场券 2022-10-05 06:59 315阅读 0赞

### ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIyMDQ5Nzcz_size_16_color_FFFFFF_t_70][] ###

### Maven依赖 ###

<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>

### config ###

package com.dg.swagger.config;
    
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.core.env.Environment;
    import org.springframework.core.env.Profiles;
    import springfox.documentation.builders.RequestHandlerSelectors;
    import springfox.documentation.service.ApiInfo;
    import springfox.documentation.service.Contact;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spring.web.plugins.Docket;
    import springfox.documentation.swagger2.annotations.EnableSwagger2;
    
    import java.util.ArrayList;
    
    @Configuration
    @EnableSwagger2
    public class SwaggerConfig {
        @Bean //配置docket以配置Swagger具体参数
        public Docket docket(Environment environment) {
            // 设置要显示swagger的环境
            Profiles of = Profiles.of("dev", "test");
            // 判断当前是否处于该环境
            // 通过 enable() 接收此参数判断是否要显示
            boolean b = environment.acceptsProfiles(of);
    
            //Docket 实例关联上 apiInfo()
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .groupName("WangDong") // 配置分组
                    .enable(b) //配置是否启用Swagger，如果是false，在浏览器将无法访问
                    .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
                    .apis(RequestHandlerSelectors.basePackage("com.dg.swagger.controller"))
                    .build();
        }
    
        @Bean
        public Docket docket1(){
            return new Docket(DocumentationType.SWAGGER_2).groupName("group1");
        }
        @Bean
        public Docket docket2(){
            return new Docket(DocumentationType.SWAGGER_2).groupName("group2");
        }
        @Bean
        public Docket docket3(){
            return new Docket(DocumentationType.SWAGGER_2).groupName("group3");
        }
    
        //配置文档信息
        public ApiInfo apiInfo() {
            Contact contact = new Contact("王东", "http://www.baidu.com", "752343054@qq.com");
            return new ApiInfo(
                    "东哥-测试", // 标题
                    "测试Swagger", // 描述
                    "v1.0", // 版本
                    "https://www.hao123.com/", // 组织链接
                    contact, // 联系人信息
                    "Apach 2.0 许可", // 许可
                    "许可链接", // 许可连接
                    new ArrayList<>()// 扩展
            );
        }
    
    }

### controller ###

package com.dg.swagger.controller;
    
    import com.dg.swagger.pojo.User;
    import io.swagger.annotations.ApiOperation;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.PostMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    public class HelloController {
    
        @PostMapping("/getUsername")
        private String getUsername(){
            return "dongge";
        }
    
        @ApiOperation("获取用户实体")
        @GetMapping("/getUser")
        public User getUser(User user){
            return user;
        }
    
    
    }

### pojo ###

package com.dg.swagger.pojo;
    
    import io.swagger.annotations.ApiModel;
    import io.swagger.annotations.ApiModelProperty;
    import lombok.Data;
    import lombok.Value;
    
    @Data
    //@ApiModel("用户")
    public class User {
    
        @ApiModelProperty("用户名")
        private String username;
        @ApiModelProperty("密码")
        private String password;
    }

### 启动类 ###

package com.dg.swagger;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    public class SwaggerDemoApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(SwaggerDemoApplication.class, args);
        }
    
    }

### swagger-ui访问路径：[http://localhost:8080/swagger-ui.html][http_localhost_8080_swagger-ui.html] ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIyMDQ5Nzcz_size_16_color_FFFFFF_t_70 1][]

### 资料来源：[https://mp.weixin.qq.com/s/0-c0MAgtyOeKx6qzmdUG0w][https_mp.weixin.qq.com_s_0-c0MAgtyOeKx6qzmdUG0w] ###

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIyMDQ5Nzcz_size_16_color_FFFFFF_t_70]: /images/20221005/a34bf9f468d84cc189737c9f6328c4df.png
[http_localhost_8080_swagger-ui.html]: http://localhost:8080/swagger-ui.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIyMDQ5Nzcz_size_16_color_FFFFFF_t_70 1]: /images/20221005/5809eb78b1cc4991a4966adb6791d309.png
[https_mp.weixin.qq.com_s_0-c0MAgtyOeKx6qzmdUG0w]: https://mp.weixin.qq.com/s/0-c0MAgtyOeKx6qzmdUG0w