swagger4jAPI 文档集成
swagger4j API 文档集成
参考文档 https://gitee.com/cpjit_group/swagger4j#parameters
加入依赖 JAR 文件
<dependency>
<groupId>com.cpjit</groupId>
<artifactId>swagger4j</artifactId>
<version>2.2.1</version>
</dependency>
<dependency>
<groupId>org.thymeleaf</groupId>
<artifactId>thymeleaf</artifactId>
<version>3.0.11.RELEASE</version>
<exclusions>
<exclusion>
<groupId>javassist</groupId>
<artifactId>javassist</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>io.github.classgraph</groupId>
<artifactId>classgraph</artifactId>
<version>4.8.43</version>
</dependency>
配置 web.xml 过滤器
<filter>
<filter-name>swaggerFilter</filter-name>
<filter-class>com.cpjit.swagger4j.SwaggerFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>swaggerFilter</filter-name>
<url-pattern>/doc/*</url-pattern>
</filter-mapping>
修改配置项
在项目的源文件目录下添加一个swagger.properties文件，并加入以下配置项
packageToScan=com.epichust
apiDescription=Swagger Doc
apiTitle=Swagger API
apiVersion=1.0.0
teamOfService=www.epichust.com
devMode=true
suffix=.m
标注接口
@Controller("mbfEquipmentController")
@APIs(hide=false)
public class MbfEquipmentController extends DefaultController{
@Override
@API(value="mbfEquipmentController!select", summary="设备基础档案查询", parameters={
@Param(name="search", description= "", dataType=DataType.BOOLEAN),
@Param(name="rows" , description="每一页显示条数", defaultValue="10",dataType=DataType.INTEGER),
@Param(name="page" , description="第几页", defaultValue="1",dataType=DataType.INTEGER),
@Param(name="sidx" , description="排序字段", defaultValue="equipCode",dataType=DataType.STRING),
@Param(name="sord" , description="排序方式", defaultValue="asc",dataType=DataType.STRING),
@Param(name="method" , description="方法名称", defaultValue="select",dataType=DataType.STRING),
@Param(name="entity" , description="实体", defaultValue="com.epichust.entity.MbfEquipment",dataType=DataType.STRING),
@Param(name="columns" , description="列名称", defaultValue="%5B%7B\"name\"%3A\"id\"%7D%2C%7B\"name\"%3A\"equipCode\"%7D%2C%7B\"name\"%3A\"equipName\"%7D%2C%7B\"name\"%3A\"model\"%7D%2C%7B\"name\"%3A\"manu\"%7D%2C%7B\"name\"%3A\"madeDate\"%2C\"fieldType\"%3A\"date\"%2C\"format\"%3A\"yyyy-MM-dd\"%7D%2C%7B\"name\"%3A\"useDate\"%2C\"fieldType\"%3A\"date\"%2C\"format\"%3A\"yyyy-MM-dd\"%7D%2C%7B\"name\"%3A\"pid\"%7D%2C%7B\"name\"%3A\"useStatus\"%7D%2C%7B\"name\"%3A\"runStatus\"%7D%2C%7B\"name\"%3A\"isNc\"%7D%2C%7B\"name\"%3A\"isTool\"%7D%2C%7B\"name\"%3A\"workCellCode\"%2C\"refEntity\"%3A\"mbfWorkCell\"%2C\"refName\"%3A\"code\"%7D%2C%7B\"name\"%3A\"workCellName\"%2C\"refEntity\"%3A\"mbfWorkCell\"%2C\"refName\"%3A\"name\"%7D%2C%7B\"name\"%3A\"workCenterName\"%2C\"refEntity\"%3A\"workCenter\"%2C\"refName\"%3A\"name\"%7D%2C%7B\"name\"%3A\"workCenterGid\"%2C\"refEntity\"%3A\"workCenter\"%2C\"refName\"%3A\"id\"%7D%2C%7B\"name\"%3A\"mbfSite\"%2C\"refEntity\"%3A\"mbfSite\"%2C\"refName\"%3A\"name\"%7D%2C%7B\"name\"%3A\"departMent\"%2C\"refEntity\"%3A\"department\"%2C\"refName\"%3A\"name\"%7D%2C%7B\"name\"%3A\"type\"%7D%2C%7B\"name\"%3A\"useMethod\"%7D%2C%7B\"name\"%3A\"capacity\"%7D%2C%7B\"name\"%3A\"maxPower\"%7D%2C%7B\"name\"%3A\"maxSpeed\"%7D%2C%7B\"name\"%3A\"minSpeed\"%7D%2C%7B\"name\"%3A\"maxSize\"%7D%2C%7B\"name\"%3A\"maxFeedrate\"%7D%2C%7B\"name\"%3A\"minFeedrate\"%7D%2C%7B\"name\"%3A\"useLife\"%7D%2C%7B\"name\"%3A\"maxWeight\"%7D%2C%7B\"name\"%3A\"isActive\"%7D%2C%7B\"name\"%3A\"remark\"%7D%5D",dataType=DataType.STRING),
})
protected IReturnData select()
{
SelectData selectData = this.getSelectService().getProcessData(this.pageData);
return mbfEquipmentService.processSelect(selectData);
}
}
菜单配置
URL 字段 umasysmanage/requestControl/docc?to=http://localhost:8080/uma-unimax-web/doc