IDEA插件EasyYapi设置导出中Markdown接口文档

优秀idea插件EasyYapi是可以导出类似于JavaDoc文档的,插件详细介绍看官方插件说明: https://easyyapi.com/documents/index.html

官网文档另有其他详细设置说明,本文只介绍Markdown设置中文导出方式

本章主要说明EasyYapi设置导出中文Markdown文件,导出后即是 easy-api.md 通过Typora软件查看

效果图

IDEA插件EasyYapi设置导出中Markdown接口文档_第1张图片

开始操作:

开始正文

    • 找到插件进行安装 搜索关键字:easyyapi
IDEA插件EasyYapi设置导出中Markdown接口文档_第2张图片
    • 本文关键点-重启idea后设置插件
IDEA插件EasyYapi设置导出中Markdown接口文档_第3张图片
    • 本文关键点-找到Remote设置选项,添加一个连接,gitee地址更快哦
https://gitee.com/tangcent/easy-yapi/raw/master/third/markdown.cn.config
IDEA插件EasyYapi设置导出中Markdown接口文档_第4张图片
    • 开始导出Markdown文档,选中controller接口类或文件夹.依次选中code>右键>EasyYapi>ExportMarkdown ,选中桌面进行导出
IDEA插件EasyYapi设置导出中Markdown接口文档_第5张图片
IDEA插件EasyYapi设置导出中Markdown接口文档_第6张图片
    • 通过Typora软件打开
IDEA插件EasyYapi设置导出中Markdown接口文档_第7张图片
IDEA插件EasyYapi设置导出中Markdown接口文档_第8张图片

    • 效果图如上,长图请见文章首页图,文档中可以看到详细的接口信息
    • 如果 文档中没有接口说明的话,请在controller中设置Java注释进行说明,见下
IDEA插件EasyYapi设置导出中Markdown接口文档_第9张图片
IDEA插件EasyYapi设置导出中Markdown接口文档_第10张图片
  1. 请求参数说明

IDEA插件EasyYapi设置导出中Markdown接口文档_第11张图片
IDEA插件EasyYapi设置导出中Markdown接口文档_第12张图片
    • 只有接口方法和实体类均加上Java注释,方可在文档中显示接口说明和参数说明

你可能感兴趣的:(ide,java)