@Configuration //注解为配置类,向spring容器注入bean对象 @EnableOpenApi public class SwaggerConfig { @Bean //把方法的返回值对象,注入容器 public Docket docket(){ return new Docket(DocumentationType.OAS_30)//选择swagger3.0版本号 .apiInfo(apiInfo()).enable(true) //获取版权声明 .select() //确定swagger能够访问到的请求接口范围,指定控制器包路径 .apis(RequestHandlerSelectors.basePackage("org.example.controller")) .paths(PathSelectors.any()) .build(); //构建对象 } //撰写项目的版本声明 private ApiInfo apiInfo(){ return new ApiInfoBuilder() .title("医院预约挂号系统") //项目的名称 .description("这是一个预约系统") //项目功能说明 .contact(new Contact("自己的名字","自己的博客网址","12141579@qq.com")) .version("1.0") .build(); } }
主要是SwaggerConfig类以及Controller类的 @Api 、@ApiOperation注解
依赖:
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency>
运行成功后的访问路径:
http://localhost:8080/swagger-ui/index.html
大功告成: