解析Java代码,自动生成文档工具使用说明
页面布局
- 左侧为菜单,菜单分为两级,一级表示模块,二级表示接口信息
-
右侧为接口详细信息,主要包括:模拟测试功能,接口详细信息说明,请求参数说明,响应参数说明,自动一个演示的例子表明接口的使用方式
如下图(图片拼接左侧菜单可能模糊或重影,凑合看):
页面操作
-
左侧二级菜单可以双击修改,失去焦点时自动保存
-
左侧一级,二级菜单可以拖拽排序
-
所有带 “编辑”按钮的地方都可以编辑保存,textarea编辑时可以带回车换行,自动记录你的文本格式
-
请求参数和响应参数,本身是一个树结构,所有编辑的时候跟普通的编辑树一样操做,包括添加一级数据,添加子数据,修改,删除,保存等等,鼠标移入会有提示,如下图
5.如果需要给接口提供默认值,修改参数的默认值后,会自动重构json参数,方便测试
代码使用
- 在你的controller类上增加注解
@Api("这里写模块名称")
,这里一个@Api对应页面的一个一级菜单,即模块,模块可以由多个类组成,只需设置每个类的模块名称一样,程序会自动把模块名称一样的class组装成同一模块。
低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。
持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。
转载内容版权归作者及来源网站所有,本站原创内容转载请注明来源。
- 上一篇
DelayQueue延时队列使用
----------TaskDelay 延时对象--------------- package com.asiainfo.audit.delay; import org.apache.log4j.Logger; import java.util.Date; import java.util.concurrent.Delayed; import java.util.concurrent.TimeUnit; import java.util.concurrent.atomic.AtomicLong; /** * 继承Delayed使其成为一个延迟对象 * 该类是一个消息体类,在延时队列中这个实现了Delayed接口的消息类是必不可少的, * 实现接口时有一个getDelay(TimeUnit unit)方法,这个方法就是判断是否到期的, * 这里定义的是一个泛型类,所以可以将我们上面的任务类作为其中的task,这样就将任务类分装成了一个消息体 * @author zhoukai7 * @email zhoukai7@asiainfo.com * @date 2017-12-02 18:23...
- 下一篇
PHP获取IP地址的方法,防止伪造IP地址注入攻击
原文: PHP获取IP地址的方法,防止伪造IP地址注入攻击 PHP获取IP地址的方法 /** * 获取客户端IP地址 * <br />来源:ThinkPHP * <br />"X-FORWARDED-FOR" 是代理服务器通过 HTTP Headers 提供的客户端IP。代理服务器可以伪造任何IP。 * <br />要防止伪造,不要读这个IP即可(同时告诉用户不要用HTTP 代理)。 * @param integer $type 返回类型 0 返回IP地址 1 返回IPV4地址数字 * @param boolean $adv 是否进行高级模式获取(有可能被伪装) * @return mixed */ function get_client_ip($type = 0, $adv = false) { $type = $type ? 1 : 0; static $ip = NULL; if ($ip !== NULL) return $ip[$type]; if ($adv) { if (isset($_SERVER['HTTP_X_FORWARDED_...
相关文章
文章评论
共有0条评论来说两句吧...
文章二维码
点击排行
推荐阅读
最新文章
- CentOS7安装Docker,走上虚拟化容器引擎之路
- Docker使用Oracle官方镜像安装(12C,18C,19C)
- CentOS8编译安装MySQL8.0.19
- Docker安装Oracle12C,快速搭建Oracle学习环境
- CentOS7编译安装Gcc9.2.0,解决mysql等软件编译问题
- CentOS6,7,8上安装Nginx,支持https2.0的开启
- CentOS关闭SELinux安全模块
- CentOS7设置SWAP分区,小内存服务器的救世主
- CentOS7编译安装Cmake3.16.3,解决mysql等软件编译问题
- CentOS8安装Docker,最新的服务器搭配容器使用