超简单!Java 项目自动生成接口文档教程

liam
• 阅读 431

你还在用 word、markdown 埋头苦干写接口文档?写文档这件事恐怕是每个开发都万分抗拒的事情了。本篇文章详细教你如何利用插件工具,在 IDEA 中自动生成 API 文档。

先来看看从 IDEA 中生成文档的效果如下图。下图是使用 Apifox 插件(Apifox helper)从 IDEA 生成的文档(右)效果。

超简单!Java 项目自动生成接口文档教程

第一步:安装插件

打开你的 IDEA,点击 File -->Settings --> Plugins,输入 Apifox Helper。 点击安装,然后等待成功后重启 IDEA.

你也可以通过 Jetbrains Marketplace 的官网下载安装。

超简单!Java 项目自动生成接口文档教程

第二步:注册一个 Apifox 账号

Apifox 是一个在线的接口文档管理工具,这一步主要是用来同步文档到项目中。支持下载桌面端或直接网页注册,并且创建一个项目。

超简单!Java 项目自动生成接口文档教程

第三步:配置令牌

接下来,你需要将 Apifox Helper 和 Apifox 的项目进行关联,也就是通过访问令牌绑定。

1、打开 Apifox, 点击左侧【头像】-->【账号设置】-->【API 访问令牌】;

2、点击【新建令牌】,填写令牌名称,点击【保存并生成令牌】。

超简单!Java 项目自动生成接口文档教程

3、复制令牌到 IDEA 中【Apifox Helper】配置项的 API 访问令牌中。同理,在 Apifox 中进入项目,【项目设置 --> 基本设置】,复制项目 ID 。

超简单!Java 项目自动生成接口文档教程

4、在 IDEA 中,点击 File-->Settings -->Other Settings,找到 Apifox Helper。 将访问令牌和项目 ID 粘贴到这里:

(服务器地址就用默认的,可以不用管。)

超简单!Java 项目自动生成接口文档教程

到这里,你就搞定了配置部分,下面就是自动生成文档了!

第四步:生成文档!

打开需要上传的 Controller 文件,右键选择「 Upload to Apifox」。

超简单!Java 项目自动生成接口文档教程

第五步:去 Apifox 项目中查看自动生成的文档

点击 Apifox 右上角的刷新图标。刚才在 IDEA 项目中的接口文档就已经在这里了。

超简单!Java 项目自动生成接口文档教程

自此,你就大功告成了!恭喜你已经拥有了一份美观整洁的接口文档。这个项目一旦有更新,你只需要右键点击「 Upload to Apifox」 就可以。

更多好用的功能

当你的文档同步到项目中,那么你就可以直接在 apifox 中直接生成一个分享链接给别人,那么他看到的文档就都是最新的,不需要再管你索要接口文档文件。

超简单!Java 项目自动生成接口文档教程

还可以直接在 Apifox 项目中直接发起接口调试、接口自动化测试等等操作。相较于 Postman,Apifox 结合它的插件 Apifox Helper 可以通过代码注解自动解析生成 API 文档,无需手动操作,同时支持远端同步,非常方便团队内的协作和更新。这是一种新型的在线协作方式,能够非常高效率帮助你进行 API 接口的分享和管理。懒人必备! 另附带 Apifox 插件官方帮助文档 ,帮助你使用。

更多关于接口文档的相关知识。:

点赞
收藏
评论区
推荐文章
liam liam
2年前
先写API文档还是先写代码?
代码未动,文档先行其实大家都知道API文档先行的重要性,但是在实践过程中往往会遇到很多困难。程序员最讨厌的两件事:1.写文档,2.别人不写文档。大多数开发人员不愿意写API文档的原因是写文档短期收益远低于付出的成本,然而并不是所有人都能够坚持做有长期收益的事情的。作为一个前后端分离模式开发的团队,我们经常会看到这样的场景:前端开发和后端开发在一起
Stella981 Stella981
3年前
DataX的Clickhouse读写插件
作者:一剑飘雪特别说明:点击文章尾部“阅读原文”链接,查看标准Markdown文档。ClickHouseReader插件文档1快速介绍ClickHouseReader插件实现了从ClickHouse读取数据。在底层实现上,ClickHous
Stella981 Stella981
3年前
SpringBoot整合Swagger3生成接口文档
  前后端分离的项目,接口文档的存在十分重要。与手动编写接口文档不同,swagger是一个自动生成接口文档的工具,在需求不断变更的环境下,手动编写文档的效率实在太低。与新版的swagger3相比swagger2配置更少,使用更加方便。一、pom文件中引入Swagger3依赖<dependency
Easter79 Easter79
3年前
SpringBoot整合Swagger3生成接口文档
  前后端分离的项目,接口文档的存在十分重要。与手动编写接口文档不同,swagger是一个自动生成接口文档的工具,在需求不断变更的环境下,手动编写文档的效率实在太低。与新版的swagger3相比swagger2配置更少,使用更加方便。一、pom文件中引入Swagger3依赖<dependency
liam liam
1年前
Swagger 自动生成 Api 文档:简单、高效的自动生成工具
自动生成API文档的好处不言而喻,它可以提供给你的团队或者外部协作者,方便API使用者准确地调用到你的。为了降低手动编写文档带来的错误,很多API开发者会偏向于寻找一些好的方法来自动生成API文档。本文将会介绍一些常用的文档生成工具:开源工具Tapir,商
API 小达人 API 小达人
1年前
「实用技巧」后端如何使用 Eolink Apikit 快速调试接口?
程序员最讨厌的两件事:1.写文档;别人不写文档。写文档、维护文档比较麻烦,而且费时,还会经常出现API更新了,但文档还是旧的,各种同步不一致的情况,从而耽搁彼此的时间,大多数开发人员不愿意写API文档。EolinkApikit为后端工程师提供API文档的创建与自动化生成、快速接口调试、以及API文档版本管理功能,协助后端工程师快速编写文档,调试接口,以及支持版本控制恢复历史记录。通过一套系统、一份数据,解决多个系统之间的数据同步问题。只要定义好接口文档,接口调试、数据Mock、接口测试就可以直接使用,无需再次定义。接口文档和接口开发调试使用同一个工具,接口调试完成后即可保证和接口文档定义完全一致。高效、及时、准确!
小万哥 小万哥
12个月前
API 参考与帮助内容:一站式开发与使用者支援
API文档API文档是旨在了解API详细信息的综合指南。通常,它们包括端点、请求示例、响应类别和示例以及错误代码等信息。API文档可帮助开发人员了解API端点的具体细节,并了解如何将API成功集成到他们的软件中。文档生成工具API文档生成工具是直接从源代码
SW SW
2年前
如何编辑 .md 文档 (基础)
如何编辑.md文档Markdown是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。Markdown语言在2004由约翰·格鲁伯(英语:JohnGruber)创建。Markdown编写的文档可以导出HTML、Word、图像、PDF、Epub等多种格式的文档。Markdown编写的文档后缀为.md,.markdow
liam liam
1年前
横空出世!IDEA 版 API 接口神器来了,一键生成文档!
每个开发都不想写文档。当你不想写接口文档时,可以通过安装插件在IDEA里实现自动同步,一边写代码一边同步接口文档给你的前端、测试同学。以下内容手把手教你怎么操作(这里仅面向使用IDEA编辑器、遵循JavaSpring框架注释规范的同学):首先,你需要安装一
Intellij IDEA 插件开发 | 京东云技术团队
很多idea插件文档更多的是介绍如何创建一个简单的idea插件,本篇文章从开发环境、demo、生态组件、添加依赖包、源码解读、网络请求、渲染数据、页面交互等方面介绍,是一篇能够满足基本的插件开发工程要求的文章。