创建common模块

在guli-parent下创建模块common

配置：

groupId：com.leon

artifactId：common

在common中引入相关依赖

<dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId><scope>provided </scope></dependency><!--mybatis-plus--><dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter</artifactId><scope>provided </scope></dependency><!--lombok用来简化实体类：需要安装lombok插件--><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><scope>provided </scope></dependency><!--swagger--><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><scope>provided </scope></dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><scope>provided </scope></dependency><!-- redis --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-data-redis</artifactId></dependency><!-- spring2.X集成redis所需common-pool2<dependency><groupId>org.apache.commons</groupId><artifactId>commons-pool2</artifactId><version>2.6.0</version></dependency>-->
</dependencies>

在common下面创建子模块service-base

在模块service-base中，创建swagger的配置类

创建包com.leon.servicebase.config，创建类SwaggerConfig

package com.leon.servicebase;import com.google.common.base.Predicates;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
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;@Configuration//配置类
@EnableSwagger2 //swagger注解
public class SwaggerConfig {@Beanpublic Docket webApiConfig(){return new Docket(DocumentationType.SWAGGER_2).groupName("webApi").apiInfo(webApiInfo()).select().paths(Predicates.not(PathSelectors.regex("/admin/.*"))).paths(Predicates.not(PathSelectors.regex("/error.*"))).build();}private ApiInfo webApiInfo(){return new ApiInfoBuilder().title("网站-课程中心API文档").description("本文档描述了课程中心微服务接口定义").version("1.0").contact(new Contact("java", "http://leon.com", "1123@qq.com")).build();}
}

在模块service模块中引入service-base

<dependency><groupId>com.leon</groupId><artifactId>service-base</artifactId><version>0.0.1-SNAPSHOT</version>
</dependency>

在service-edu启动类上添加注解，进行测试

@SpringBootApplication
@ComponentScan(basePackages = {"com.leon"})
public class EduApplication {public static void main(String[] args) {SpringApplication.run(EduApplication.class, args);}
}

API模型

可以添加一些自定义设置，例如：

定义样例数据

@ApiModelProperty(value = "创建时间", example = "2019-01-01 8:00:00")
@TableField(fill = FieldFill.INSERT)
private Date gmtCreate;@ApiModelProperty(value = "更新时间", example = "2019-01-01 8:00:00")
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date gmtModified;

定义接口说明和参数说明

定义在类上：@Api

定义在方法上：@ApiOperation

定义在参数上：@ApiParam

@Api(description="讲师管理")
@RestController
@RequestMapping("/admin/edu/teacher")
public class TeacherAdminController {@Autowiredprivate TeacherService teacherService;@ApiOperation(value = "所有讲师列表")@GetMappingpublic List<Teacher> list(){return teacherService.list(null);}@ApiOperation(value = "根据ID删除讲师")@DeleteMapping("{id}")public boolean removeById(@ApiParam(name = "id", value = "讲师ID", required = true)@PathVariable String id){return teacherService.removeById(id);}}

配置Swagger2相关推荐

JAVA入门[23]-SpringBoot配置Swagger2
一.新建SpringBoot站点 1.新建module,然后引入pom依赖: <parent><groupId>org.springframework.boot</gro ...
SpringBoot配置swagger2(亲测有效，如果没有配置成功，欢迎在下方留言)
一.导包: <dependency><groupId>io.springfox</groupId><artifactId>springfox-swagg ...
SSM 配置 Swagger2 接口文档引擎
POM 增加 Swagger2 所需依赖,pom.xml 配置如下:  <dependency><groupId>io ...
java：springboot1.x/springboot2.x配置swagger2登录密码/设置swagger访问权限
需求描述需要将springboot项目的swagger文档配置为输入用户名密码登录后才可访问,即: springboot1.x配置方法首先需要在pom.xml中引入依赖包(需要确保只引入这一个se ...
项目配置Swagger2生成API接口文档
一.Swagger2介绍前后端分离开发模式中,api文档是最好的沟通方式. Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务. 及时性 (接 ...
springboot细节挖掘（配置Swagger2）
首先启动一个springboot的项目: 配置pow.xml,在maven里面添加依赖 <dependency&g ...
【swagger2】Spring Boot 配置swagger2
说明:本文写作目的单纯是记录一次项目搭建,以便于以后查看. 开发工具:IDEA:操作系统:MacOS 文章目录前言一.引入依赖二.修改配置文件三.Docket编写遇到的问题前言 Swagg ...
Springboot配置Swagger2
方式:创建Java类来配置Swagger设置 1.在pom.xml添加依赖 <dependency><groupId>io.springfox</groupId>& ...
springboot 中配置Swagger2
1.引入依赖 <dependency><groupId>io.springfox</groupId><arti ...

配置Swagger2

创建common模块

在common中引入相关依赖

在common下面创建子模块service-base

在模块service-base中，创建swagger的配置类

在模块service模块中引入service-base

在service-edu启动类上添加注解，进行测试

API模型

定义接口说明和参数说明

配置Swagger2相关推荐

最新文章

热门文章