【6】Spring Boot系列之Swagger

川长思鸟来 2022-03-29 02:01 174阅读 0赞

(1)引入依赖

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

(2)swagger配置

@Configuration
    @EnableSwagger2
    public class Swagger2 { 
    	@Bean
    	public Docket createRestApi() { 
    		return new Docket(DocumentationType.SWAGGER_2)
    				.apiInfo(apiInfo())// 可省略
    				.select()
    				.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
    				.paths(PathSelectors.any()).build();
    	}
    
    	// 构建 api文档的详细信息函数,注意这里的注解引用的是哪个
    	private ApiInfo apiInfo() { 
    		return new ApiInfoBuilder()
    				.title("Spring Boot 测试使用 Swagger2 构建RESTful API")// 页面标题
    				.contact(new Contact("某人", "http://www.baidu.com", "abc@qq.com")) // 创建人信息
    				.version("1.0")// 版本号
    				.description("API 描述").build();// 描述
    	}
    }

（3）接口

@Api(tags = "用户接口")
    @RestController
    @RequestMapping("/common")
    public class HelloRestController { 
    	
    	@ApiOperation(value = "根据id查询学生信息", notes = "查询数据库中某个的学生信息")
    	@RequestMapping(value="/common/a", method = RequestMethod.GET)
        public String common() { 
            return "Hello World1";
        }
    }

（4）效果展示  
打开 [http://localhost:8080/swagger-ui.html][http_localhost_8080_swagger-ui.html]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpc2hrMzE0_size_16_color_FFFFFF_t_70]

参考：[https://www.cnblogs.com/fengli9998/p/7522973.html][https_www.cnblogs.com_fengli9998_p_7522973.html]

[http_localhost_8080_swagger-ui.html]: http://localhost:8080/swagger-ui.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpc2hrMzE0_size_16_color_FFFFFF_t_70]: /images/20220329/388ff4cd7bff45388d00524dbb966d7c.png
[https_www.cnblogs.com_fengli9998_p_7522973.html]: https://www.cnblogs.com/fengli9998/p/7522973.html