代码拉取完成,页面将自动刷新
同步操作将从 江南久无雪/jfinal-swagger 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
上周开始接触JFinal框架,第一感觉就是提高了开发速度。之前使用Spring的时候,方便API文档生成,便集成了Swagger 在研究一段时间后,决定将Swagger集成到JFinal中,由于时间仓促,当前第一版本提供基础功能
1. 添加依赖
<dependency>
<groupId>com.feizhou</groupId>
<artifactId>jfinal-swagger</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
2. 下载 swagger-ui-master 将 dist 中文件加入到项目中
可配置成类似如下路径:
webapp
static
swagger
favicon-16x16.png
...
swagger-ui.js.map
WEB-INF
views
swagger
index.html
3. 增加Swagger路由控制
// 可以用此方式增加全局参数 如token
SwaggerGlobalPara.addPara(new SwaggerPath.Parameter(
"x-access-token", "header", "令牌", false, "string", "", ""
));
以第二步的形式配置的目录结构,可直接使用如下路由配置
routes.add(new SwaggerRoutes());
也可自行配置路由信息
public class SwaggerRoutes extends Routes {
@Override
public void config() {
setBaseViewPath("/WEB-INF/views");
add("/swagger", SwaggerController.class);
}
}
4. 添加注解
提供四种注解:
@Api(tag = "index", description = "测试输出")
@ApiOperation(url = "/test", tag = "index", httpMethod = "get", description = "测试json")
@Param(name = "id", description = "编号", required = true, dataType = "Long")
@Params
5. 配置扫描包信息
config.properties增加:swagger.base_package
如:
swagger.base_package=com.feizhou.swagger.test
6. 增加文件参数支持
增加 consumes = "multipart/form-data"
@ApiOperation(url = "/test2", tag = "index", httpMethod = "post", description = "测试json", consumes = "multipart/form-data")
设置 dataType = "file"
@Param(name = "file", description = "文件", required = true, dataType = "file")
注解使用示例:
@Api(tag = "index", description = "测试输出")
public class IndexController extends Controller {
public void index() {
setAttr("aaa", "aaaaaa");
this.render("index.html");
}
@ApiOperation(url = "/test", tag = "index", httpMethod = "get", description = "测试json")
@Params({
@Param(name = "id", description = "编号", required = true, dataType = "Long"),
@Param(name = "name", description = "姓名", required = true, dataType = "String")
})
public void test() {
List<String> list = Arrays.asList("123","456");
this.renderJson(list);
}
}
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。