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

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

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

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数据格式的两种常用方式

相关推荐

如何设计一个优秀的电子商务产品详情页: 加入人人都是产品经理【起点学院】产品经理实战训练营，BAT产品总监手把手带你学产品电子商务网站的产品详情页面无疑是设计师和开发人员关注的最重要的网页之一。产品详情页面是客户作出“加入购物车”决定的页面...

怎么在JS中使用Ajax进行异步请求?: 大家好，今天我来分享一项JavaScript的实战技巧，即如何在JS中使用Ajax进行异步请求，让你的网页速度瞬间提升。Ajax是一种在不刷新整个网页的情况下与服务器进行数据交互的技术，可以实现异步加...

中小企业如何组建,管理团队_中小企业应当如何开展组织结构设计变革: 前言写了太多关于产品的东西觉得应该换换口味.从码农到架构师,从前端到平面再到UI、UE,最后走向了产品这条不归路,其实以前一直再给你们讲.产品经理跟项目经理区别没有特别大,两个岗位之间有很...

前端监控 SDK 开发分享_前端监控系统开源: 一、前言随着前端的发展和被重视，慢慢的行业内对于前端监控系统的重视程度也在增加。这里不对为什么需要监控再做解释。那我们先直接说说需求。对于中小型公司来说，可以直接使用三方的监控，比如自己搭建一套免费的...

Ajax 会被 fetch 取代吗?Axios 怎么办?: 大家好，很高兴又见面了，我是"高级前端进阶"，由我带着大家一起关注前端前沿、深入前端底层技术，大家一起进步，也欢迎大家关注、点赞、收藏、转发！今天给大家带来的主题是ajax、fetch...

前端面试题《AJAX》_前端面试ajax考点汇总: 1.什么是ajax？ajax作用是什么？AJAX=异步JavaScript和XML。AJAX是一种用于创建快速动态网页的技术。通过在后台与服务器进行少量数据交换,AJAX可以使网页实...

Ajax 详细介绍_ajax: 1、ajax是什么?asynchronousjavascriptandxml:异步的javascript和xml。ajax是用来改善用户体验的一种技术，其本质是利用浏览器内置的一个特殊的...

6款可替代dreamweaver的工具_替代powerdesigner的工具: dreamweaver对一个web前端工作者来说，再熟悉不过了，像我07年接触web前端开发就是用的dreamweaver，一直用到现在，身边的朋友有跟我推荐过各种更好用的可替代dreamweaver...

我敢保证，全网没有再比这更详细的Java知识点总结了，送你啊: 接下来你看到的将是全网最详细的Java知识点总结，全文分为三大部分：Java基础、Java框架、Java+云数据小编将为大家仔细讲解每大部分里面的详细知识点，别眨眼，从小白到大佬、零基础到精通，你绝...

福斯《死侍》发布新剧照 "小贱贱"韦德被改造前造型曝光: 时光网讯福斯出品的科幻片《死侍》今天发布新剧照，其中一张是较为罕见的死侍在被改造之前的剧照，其余两张剧照都是死侍在执行任务中的状态。据外媒推测，片方此时发布剧照，预计是为了给不久之后影片发布首款正式预...

2021年超详细的java学习路线总结—纯干货分享: 本文整理了java开发的学习路线和相关的学习资源，非常适合零基础入门java的同学，希望大家在学习的时候，能够节省时间。纯干货，良心推荐！第一阶段：Java基础重点知识点：数据类型、核心语法、面向对象...

不用海淘，真黑五来到你身边:亚马逊15件热卖爆款推荐!: Fujifilm富士instaxMini8小黄人拍立得相机（黄色/蓝色）扫二维码进入购物页面黑五是入手一个轻巧可爱的拍立得相机的好时机，此款是mini8的小黄人特别版，除了颜色涂装成小黄人...

2025 年 Python 爬虫四大前沿技术:从异步到 AI: 作为互联网大厂的后端Python爬虫开发，你是否也曾遇到过这些痛点：面对海量目标URL，单线程爬虫爬取一周还没完成任务；动态渲染的SPA页面，requests库返回的全是空白代码；好不容易...

最贱超级英雄《死侍》来了!_死侍超燃: 死侍Deadpool(2016)导演:蒂姆·米勒编剧:略特·里斯/保罗·沃尼克主演:瑞恩·雷诺兹/莫蕾娜·巴卡林/吉娜·卡拉诺/艾德·斯克林/T·J·米勒类型:动作/...

停止javascript的ajax请求，取消axios请求，取消reactfetch请求: 一、Ajax原生里可以通过XMLHttpRequest对象上的abort方法来中断ajax。注意abort方法不能阻止向服务器发送请求，只能停止当前ajax请求。停止javascript的ajax请求...

一周热门

最近发表

首页
收录
顶部