您现在的位置是:首页 > 文章详情

解析Java代码,自动生成文档工具使用说明

日期:2018-09-19点击:348

页面布局

  1. 左侧为菜单,菜单分为两级,一级表示模块,二级表示接口信息
  2. 右侧为接口详细信息,主要包括:模拟测试功能,接口详细信息说明,请求参数说明,响应参数说明,自动一个演示的例子表明接口的使用方式
    如下图(图片拼接左侧菜单可能模糊或重影,凑合看):


    img_910cbdcdcfd8c5f2228e9af1af12943a.png
    演示页面布局

页面操作

  1. 左侧二级菜单可以双击修改,失去焦点时自动保存


    img_53f67b6d5e8d1663a28419f0019afd06.png
    image.png
  2. 左侧一级,二级菜单可以拖拽排序


    img_027651b07ddab14b4d386cbcd3cd1b9f.png
  3. 所有带 “编辑”按钮的地方都可以编辑保存,textarea编辑时可以带回车换行,自动记录你的文本格式


    img_bd527f01908bd07a814ac892f72dbc14.png

    img_0ef57389474f58bd5109b23ed15fc0a0.png
  4. 请求参数和响应参数,本身是一个树结构,所有编辑的时候跟普通的编辑树一样操做,包括添加一级数据,添加子数据,修改,删除,保存等等,鼠标移入会有提示,如下图


    img_f33da15c1b0790e3d98de42889ce6d65.png

    5.如果需要给接口提供默认值,修改参数的默认值后,会自动重构json参数,方便测试


    img_e59babf9d820b78c5a33e8b2770c1af5.png

代码使用

  1. 在你的controller类上增加注解@Api("这里写模块名称"),这里一个@Api对应页面的一个一级菜单,即模块,模块可以由多个类组成,只需设置每个类的模块名称一样,程序会自动把模块名称一样的class组装成同一模块。
原文链接:https://yq.aliyun.com/articles/659414
关注公众号

低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。

持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。

转载内容版权归作者及来源网站所有,本站原创内容转载请注明来源。

文章评论

共有0条评论来说两句吧...

文章二维码

扫描即可查看该文章

点击排行

推荐阅读

最新文章