当前位置：网站首页 > 技术文章 > 正文

自动生成api接口文档-java版

myzbx 2025-01-01 21:41 29 浏览

1、选择原因

个人比较懒惰，不想写注释。
不想引入依赖，侵入代码。
安全，不托管到外网，可以部署到内网。
可以离线下载。

最终选择yapi。

2、安装

官网地址：https://hellosean1025.github.io/yapi/index.html

安装方式如下：

内网部署

地址：https://hellosean1025.github.io/yapi/devops/index.html

对小白用户不是太友好。

docker部署

地址：https://github.com/fjc0k/docker-YApi

安装后访问地址

http://{ip}:40001

3、idea使用

安装插件easyapi

Preferences(Settings) > Plugins > Browse repositories... > find"EasyYapi" > Install Plugin

easyYap配置

从访问地址中获取token

idea配置用户相关信息

模板注释配置

类注释

 * @className $className$
 * @author geoffrey
 * @date $DATE$ 
 * @version V1.0
 **/

方法注释

 * @methodName: $methodName$ $params$
 * @return: $return$
 * @author: geoffrey
 * @date: $date$
 **/

4、easyYapi使用

导出当前选中文件或者文件夹所有接口

使用ExportYapi

生成效果

导出一个或多个的接口

使用Export Api

点击点击[?]按钮或者按回车键完成导出。

生成效果

HTML API

上一篇：Magic-API介绍
下一篇：在.NET Web API中设置响应输出Json数据格式的两种常用方式

相关推荐

攀升战境S5电竞主机评测:NVIDIA RTX 3060实力助阵，光追游戏走起: 此次笔者将为玩家们推荐一款游戏主机——攀升战境S5。该主机是攀升电脑今年力推的游戏装备，主机采用一线品牌配件，特别是在显卡选用上严苛把关，精选GeForceRTX30系列显卡，玩家们大可以放心选购...

慎买-神牛闪光灯兼容性问题:神牛V350&松下S5M2: 神牛V350和松下S5M2的兼容性问题。大家好，我是向往闪光灯人像的Fish。国庆期间，我购买了神牛V350闪光灯和神牛X2T引闪器，但这成为了我的噩梦。我原以为客服和松友们说这款闪光灯在松下S5M2...

Acer蜂鸟持续办公一整天（acer 蜂鸟s5）: 移动办公在工作节奏日益加快的今天越来越普遍，目前大部分工作无法在手持设备上完成，笔记本依然是移动办公最明智的选择。为了实现移动办公，很多笔记本越做越轻薄，性能也越来越强，而续航却一直没有很大提升。笔者...

职业车手明年会骑什么?2021赛季各大世巡赛车队使用器材一览: 新年的钟声即将敲响，意味着充满魔幻色彩的2020年即将过去。受新冠肺炎的影响，2020年的赛季非常不同寻常。因这一原因不得不延迟举行的各种比赛导致许多车队的赞助商无法得到足够曝光，这也间接导致了许多车...

三星部分手机系统升级路线图流出（三星系统在哪升级）: 三星包括Note3和S5在内的手机在升级到4.4.2系统之后一直没有什么系统升级的消息，而最近流出的一张三星的系统升级路线图中出现了一共13台手机升级KTU84P（也就是Android4.4.4）...

索尼Xperia Z3配置大曝光:升级并不大: IT之家（www.ithome.com）：索尼XperiaZ3配置大曝光：升级并不大索尼明天就会在IFA2014大会上发布其下代旗舰XperiaZ3智能手机，目前网上曝光了其原型机，并且机身背后...

不进反退三星Exynos 5433只能运行32位模式?: 三星GalaxyNote4将带有两个版本，除了国行使用的骁龙805以外，还有三星自家的Exynos5433版本。而这颗SoC的详细信息三星并没有公布，据外媒Anandtech称，他们从源码中确认...

尼康Z6III测评:对比EOS R6 II、A7M4、S5IIX: 摄影器材测评网站DPReview刚刚发布了尼康Z6III的完整图文测评，该机获得金奖评级，得分达到91%。以下是该文章的摘录——尼康Z6III核心规格：2400万像素“部分堆栈式”传感器RAW连拍：机...

赛默飞Ion S5首批数据公布，玩爆前任PGMTM系列: 北美时间9月1日，赛默飞发布了两款最新的NGS系统IonS5和IonS5XL，旨在提供更加简捷的靶向测序流程。10月29日IonS5测序仪的首批实验数据产生于阜外医院。阜外医院研究人员选用了主...

Excel技巧:快速制作批量文件夹，省时省力，加强工作效率: 大家好，如果公司领导要求按人员姓名制作文件夹，以一人一档的形式呈现人员档案，办公人员一个一个制作费时费力，而且效力低下，今天为大家介绍快捷制作批量文件夹的方法下面我们用图片来进行演示操作打开表格，选...

国行、港版、美版Apple watch各版本售价一览: 今天凌晨，苹果牌手表正式发布，苹果开始正式进入可穿戴设备领域，除了功能和外观，我相信大家更关心的是价格问题了，小编就将国行、港版、美版的Applewatch售价做一总结，以供参考。国行：美版：港版：...

松下全画幅微单S5和S1到底哪里不一样?: Hello，我是ET，欢迎大家来到我的“相机笔记”。————9月2日晚，松下正式发布了第4款全画幅微单LUMIXS5。这一篇，我们主要来说松下LUMIXS5和LUMIXS1到底有哪些区别...

融会贯通之典范神舟S7-2021S5评测: 便携、性能、续航，这简简单单的六个字道出了这么些年来笔记本电脑的设计方向，可是由于底层技术、模具设计等等原因，这三点并不能很好的融合在一起。虽说闻道有先后，术业有专攻，但能够有一台融会贯通的产品，不是...

三国志战略版:S5赛季装X指南，开荒不是一成不变，需要因地制宜: 大家好我是零氪玩家花席，S5赛季已经开始，因为S5赛季的野地阵容和S4赛季没有区别，所以S5赛季开荒相对不难。你在S4有经验，并且多了很多武将和战法，还能用150赛季功勋兑换7500战法点。S5赛季新...

聊聊松下S5M2和S5M2X的区别（松下s5k和s5c有什么区别）: 先简单说下哪里不同：12bitRAWHDMI外录支持直接将视频录制到USB-SSD上多了All-Intra和ProRes编码支持有线/无线IP推流，USB网络连接黑化的机身不过要特别强调一下，S5...

一周热门

最近发表

首页
收录
顶部