使用Jfinal[版本3.6] +Swagger 实现前后端开发时 接口文档管理
步骤1:
1. 下载 jfinal-swagger-1.0.0.jar
下载地址:
<dependency>
<groupId>live.autu</groupId>
<artifactId>jfinal-swagger</artifactId>
<version>1.0.0</version>
</dependency>
步骤2:
2. 下载swagger-ui , 放入项目中,存放目录如下:
下载地址: https://gitee.com/zhanghe687/jfinal_swagger_ui.git
步骤3:
修改jfinal的config.java
/**
* API引导式配置
*/
public class WebConfig extends JFinalConfig {
/**
* 配置常量
*/
WallFilter wall = new WallFilter();
public void configConstant(Constants me) {
// 加载少量必要配置,随后可用PropKit.get(...)获取值
PropKit.use("web_config.txt");
me.setDevMode(PropKit.getBoolean("devMode", false));
me.setBaseUploadPath(PropKit.get("uploadpath"));
}
/**
* 配置路由
*/
public void configRoute(Routes me) {
//这个要引用live.autu.plugin.jfinal.swagger.config.routes
me.add(new SwaggerRoutes());
//下面是自己自定义的Routes
me.add(new RoleRoutes());
me.add("/", LoginController.class); // 第三个参数为该Controller的视图存放路径
me.add("/user", UserController.class);//用户管理
}
//业务
public static DruidPlugin createC3p0Plugin_data() {
return new DruidPlugin(PropKit.get("jdbcUrl_data"),PropKit.get("user_data"), PropKit.get("password_data").trim());
}
/**
* 配置插件
*/
public void configPlugin(Plugins me) {
me.add(new SwaggerPlugin(new SwaggerDoc().setBasePath("/st_sys").setHost("127.0.0.1:8080").setSwagger("2.0").setSchemes(Arrays.asList("http"))
.setInfo(new SwaggerApiInfo("jfinal swagger demo", "1.0", "jfinal swagger", ""))));
DruidPlugin c3_data = createC3p0Plugin_data();
me.add(c3_data);
ActiveRecordPlugin arp_data = new ActiveRecordPlugin("st_data",c3_data);
me.add(arp_data);
ibasic.web.com.model.st_data._MappingKit.mapping(arp_data);
}
/**
* 配置全局拦截器
*/
public void configInterceptor(Interceptors me) {
// me.addGlobalActionInterceptor(new GlobalActionInterceptor());
}
/**
* 配置处理器
*/
public void configHandler(Handlers me) {
}
@Override
public void afterJFinalStart() {
SearchIndexer.getSearchClient();
}
/**
* 建议使用 JFinal 手册推荐的方式启动项目 运行此 main
* 方法可以启动项目,此main方法可以放置在任意的Class类定义中,不一定要放于此
*/
public static void main(String[] args) {
JFinal.start("WebContent", 8082, "/", 5);
}
@Override
public void configEngine(Engine arg0) {
// TODO Auto-generated method stub
}
最后使用:?http://127.0.0.1:8080/st_sys/swagger? 即可使用
?
?
|