jfinal-swagger让你的应用接口更加简单

前言

前两天逛jfinal社区,看到jfinal-swagger项目,接触到swagger,研究了一番对部分代码进行修改,成功整合到LMS,支持jfinal 多模块扫描,去除冗余依赖,修改try it out 问题等 。具体代码使用请见LMS

Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。 Swagger 让部署管理和使用功能强大的API从未如此简单。

配置方法

  1. 下载jfinal-swagger到本地,具体问题修改参考LMS的common模块,然后mvn clean install。
 <dependency>
    <groupId>com.feizhou</groupId>
    <artifactId>jfinal-swagger</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

2.下载你喜欢的 swagger-ui组件包: https://github.com/swagger-api/swagger-ui

将资源文件放入到webapp下,(不要求路径和我一致作参考),** 注意修改 index.html 文件中的资源路径,搞成绝对路径最好啦 **

  1. 添加一个 swagger的路由,** 注意对应上文中的资源路径 **
add("/swagger", SwaggerController.class);

开始使用

@Api(tag = "user", description = "用户管理")
public class SysUserController extends BaseController {
    /**
     * 删除用户
     */
    @ApiOperation(url = "/admin/user/userDel", tag = "user", httpMethod = HttpMethods.GET, description = "用户删除")
    @Params({@Param(name = "id", required = true, dataType = DataType.INTEGER, description = "用户ID")})
    @RequiresPermissions("user:del")
    public void userDel() {
        int userId = getParaToInt("id");
        userService.deleteUserById(userId);
        renderSuccess("删除成功");
    }
}

结果

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏技术小黑屋

快速高效调试移动端前端代码

通常,前端调试输出一些日志信息可以使用alert或者console, 当然在Desktop机器上很容易,很多浏览器都支持,如果是在手机上,可能比较麻烦,怎么得到...

20510
来自专栏杨建荣的学习笔记

Datapump数据迁移前的准备工作(二)(r9笔记第59天)

之前写了一篇文章分析了Datapump迁移数据的一些准备总结,反响还不错。Datapump数据迁移前的准备工作,最近碰到一个场景,根据评估还是使用Datapum...

29240
来自专栏冰霜之地

手把手教你利用Jenkins持续集成iOS项目

众所周知,现在App的竞争已经到了用户体验为王,质量为上的白热化阶段。用户们都是很挑剔的。如果一个公司的推广团队好不容易砸了重金推广了一个APP,好不容易有了一...

18330
来自专栏Laoqi's Linux运维专列

Saltstack 基础安装配置

21860
来自专栏Guangdong Qi

根据友盟统计错误分析查找线上BUG(工具篇)

今天线上的版本出现了BUG,在启动APP的时候出现闪退情况,但是这种BUG在正常测试的时候没有测试到,怎么解决呢

1K10
来自专栏aCloudDeveloper

UNIX环境高级编程笔记之文件I/O

一、总结   在写之前,先唠几句,《UNIX环境高级编程》,简称APUE,这本书简直是本神书,像我这种小白,基本上每看完一章都是“哇”这种很吃惊的表情。其实大概...

248100
来自专栏王亚昌的专栏

iostat命令使用

天刚上线了一台server,观察了一下,发现io比较高,想到了iostat命令,观察了一下(每隔一秒打印一次),发现有一个守护进程每隔几秒就写一次IO,再top...

8820
来自专栏IT大咖说

基于Spring Cloud及K8S构建微服务应用

摘要 广发证券蔡波斯先生通过三个大方向来为我们分享基于Spring Cloud及K8S构建微服务应用。 ? 基于Spring Cloud构建微服务 Netfli...

1.4K80
来自专栏Android机动车

阿里发布的规约插件使用指南

10月14日,阿里巴巴在杭州云栖大会上,正式发布了由阿里巴巴 P3C 项目组,经过 247 天的持续研发,正式发布众所期待的 《阿里巴巴 Java 开发规约》的...

8410
来自专栏大魏分享(微信公众号:david-share)

通过Swagger生成的Json创建Service&自定义开发者界面 | API Management学习第三篇

为Red Hat 3scale API Management管理的API创建API文档,了解Developer Portal和自定义,并探索3scale的其他基...

1.4K20

扫码关注云+社区

领取腾讯云代金券