java官方api中文文档—java api文档中文版 收藏 0

【Java版源码】YesApi接口管理系统云服务平台——国产软件推荐

YesApi Pro Java版 是一套API管理平台及源代码， 基于主流的Java+MySQL+Vue3+Docker，是一套开发、管理和提供接口计费等功能的软件、源代码和解决方案。

1.1 系统价值

果创科技YesApi接口管理系统云服务平台，是一套API管理平台及源代码， 基于主流的Java+MySQL+Vue3+Docker，是一套开发、管理和提供接口计费等功能的软件、源代码和解决方案。可以为企业缩短API接口开发周期和管理成本，快速实现接口开放和管理、接口计费，降低平台搭建成本。面向互联网行业、传统企业数字化信息建设以及软件开发领域。

1.2 系统功能描述

主要功能包括：开发者账号管理、应用管理、接口管理、接口监控统计、数据库配置管理。

其中，开发者账号管理用于对平台的账号进行管理，包括开发者用户账号、管理员账号和普通用户的账号管理。应用管理模块，主要负责开发者的应用的管理、审核和创建。接口管理模块，则于对接口的权限进行分配、控制和审批。接口监控统计负责对接口流量、访问次数、响应时间和接口请求的日志进行审记记。数据库配置管理则主要负责平台数据库连接的配置、管理和记录。

管理员在登录界面，在登录窗口输入用户名、登录密码、图形验证码，点击“登录”按钮进行登录验证。管理员用户可以切换 白天或黑夜 模式。管理后台不支持注册，只能在管理后台进行管理员的账号创建和权限分配。

以下是白天模式的登录界面：

以下是默认模式的登录界面，适合晚上使用：

进入管理后台后，可以看到管理后台的首页，即主界面。其他功能菜单和模块，按界面指引操作即可。

在后台首页，可以快速查看诸如：待审核应用、全部账号、今日接口请求次数、全部接口数量等整体概况。以及：接口流量统计图表、近期统计表格数据、昨日活跃App和系统授权信息等。

其中，首页几个统计数据的口径是：

• 接口流量统计：根据接口请求日记实时统计最近7天的接口流量。
• 账号分布：当前平台个人开发者、企业开发者、普通管理员和超级管理员的账号数量分布和丙图统计。
• 数据统计：

新注册账号：当天新增的开发者账号数量+会员数量+管理员数量。

新应用数量：当天新增且待审核的应用数量。

新接口请求：当天OpenAPI接口请求次数。

新订单：当天新创建的订单数量。

全部账号：全部的开发者账号数量+会员数量+管理员数量。

全部应用数量：平台全部的应用数量。

全部接口请求：平台累计的OpenAPI接口请求次数。

全部订单：平台累计创建的订单数量。

点击左侧功能菜单可以展开折叠菜单，和点击进入具体的功能界面。下面按功能模块简单介绍管理后台的功能。

管理人员点击左侧菜单【API接口管理】，可以进入到API接口管理。在接口权限子模块，分别有菜单：接口权限分配、接口权限规则设置、账号接口申请审核。

在【接口权限分配】界面，管理员可以为个人开发者或企业开发者，针对各个接口进行权限分配，点击【开启】分配权限，点击【禁用】取消接口权限，详情如下所示：

在【接口权限规则配置】，管理员可以搜索：接口服务、账号类型、账号ID、app_key。点击【+创建新规则】，可以唤起创建新规则弹窗，并创建新的接口权限分配规则。

针对 接口服务操作， 授予权限给开发者角色、 开发者账号、 开发者应用。 维度越细，优先级越高。在每一个权限规则，点击【开启】分配权限，点击【禁用】取消接口权限，点

击【编辑】可以继续修改。详情如下图所示：

在【账号接口申请审核】，管理员可以针对开发者申请的接口权限进行审批或拒绝。管理员点击【通过】可以审批通过权限的申请，点击【不通过】则拒绝。审批结束后将会显示审批的结果，例如：申请通过/申请不通过。

在【接口监控】子模块的【每日接口统计】界面，管理员可以查看接口请求总量分布，平均接口响应时长分布，以及对接口统计进行按日期范围、开发者ID、应用的搜索。

API接口计费，主要用于对接口的流量套餐进行管理。管理员点击【API接口计费】，可以进入到接口流量套餐列表管理界面。如下所示。管理员可以点击【+添加套餐】，配置新的接口套餐。也可以在列表对已配置的接口套餐进行搜索、查看和管理。点击【编辑】可以修改接口套餐，点击【删除】可以删除接口套餐。接口套餐的信息主要包括：套餐名称、接口名称、类型、接口流量（次）、套餐价格、有效日期和状态。

账号的查看和管理，包括：开发者账号、管理员账号、普通用户账号等。也可以在管理后台直接添加新账号、重置密码、禁用账号等操作。

管理员点击【账号管理】模块，可以进入到【账号列表】管理界面。在搜索框，管理员可以搜索账号ID、账号名、账号类型（分为：普通会员、个人开发者、企业开发者、普通管理员、超级管理员），点击【搜索】按钮进行搜索。点击【重置】重置搜索条件。

如下图所示：在【状态】这一列，点击【禁用】可以禁用账号，点击【开启】可以恢复账号使用。点击【编辑】可以编辑修改账号信息，点击【删除】可以永久删除账号。

编辑账号的界面如下，可以修改：账号类型、重置密码、昵称、电话号码、邮箱地址。点击【提交】按钮，完成保存。

在【添加新账号】界面，根据创建新账号的表单，管理员可以填写或选择：账号类型、账号、登录密码、确认密码、昵称、电话号码、邮箱地址、上传头像。点击【提交】可以创建新账号。

在【应用管理模块】，管理员可以对开发者应用的创建、查看、审核和管理。如下图所示。可以搜索应用名称、app key、审核状态，点击【搜索】或【重置】搜索条件。在【状态】这一列，可以点击【启用】恢复应用使用状态，点击【禁用】则禁止应用的使用。点击【编辑】可以修改应用信息。例如：修改应用名称、重置密钥等操作。

管理员点击【创建新应用】菜单，可以进入到创建新应用界面。点击【返回】放弃创建新应用。填写：应用名称、所属机构、App Key和密钥则由平台系统自动随机生成，也支持由管理员手动输入或修改、账号ID，点击【提交】完成新应用的创建。创建应用时，可以同时关联到指定的开发者账号，成功创建应用后需要继续完成前面接口权限的分配。

管理员点击【数据库配置管理模块】，可以进入到数据库配置管理，主要用于进行数据库连接的配置、维护和管理。成本配置后，可以提供给API接口进行调用和开发。点击【删除】可以删除不需要的配置，点击【编辑】可以继续编辑和修改数据库配置，以及进行数据库连接的测试。

管理员在右上角点击【+添加新数据库配置】，可以进入到【数据库配置管理 – 添加】界面。根据表单，填写或选择以下数据库连接信息：数据库类型、数据库地址/IP地址、数据库端口、数据库账号、数据库密码、数据库名、数据库编码、数据库表前缀。最后点击【保存配置】可以完成数据库连接信息配置的保存。

站点配置模块，主要负责网站的全局配置，包括但不限于：

• 网站项目名称
• Logo图片、Icon图标
• 网站SEO设置
• 底部备案号、备案跳转链接
• 网站访问统计代码
• 开发者注册和应用配置：开放平台注册控制、普通会员注册控制、开发者注册时是否自动创建默认应用、每个开发者的应用数量上限、应用初始每日接口次数上限、账号申请权限是否需要审核等配置管理。

作为管理员个人的管理功能，主要有以下功能：

• 个人资料（查看和个人资料修改）
• 修改密码
• 退出登录

管理员，在右上角，点击账号名称，在下拉菜单，可以依次进入：个人资料、修改密码和注销登出操作。可以个人资料界面如图所示，点击【修改个人资料】，可以更新自己的账号信息。

管理员点击右上角配置图标，可以进入到【项目配置】的右侧菜单，可以根据自己的使用和界面偏好，切换：白天或黑夜模式。以及切换选择主题颜色。还可以开启或关闭水印，也可以选择导航设置模式。

YesApi Pro Java版 包括 平台官网、API接口、管理后台和开放平台 等多个子系统，开发体验演示环境：

• 平台首页：http://java.test.yesapi.cn/
• 开放平台：http://java.test.yesapi.cn/platform/
• 管理后台：http://java.test.yesapi.cn/admin/
• API接口文档：http://java.api.yesapi.cn/api/swagger-ui/index.html#
• 技术文档：http://java.test.yesapi.cn/wiki/

零侵入！试试这款Api接口文档生成器！

大家好，我是 Java陈序员。

作为一名合格的程序员，不仅代码要写好，而且文档要写好。

虽然目前有成熟的框架可以快速生成接口文档，如大名鼎鼎的 Swagger.但是 Swagger 需要编写大量的注解来辅助生成文档，侵入了业务代码。不符合高内聚、低耦合的编程规范！

今天，给大家介绍一款零侵入的 Api 接口文档生成工具！

关注微信公众号：【Java陈序员】，获取开源项目分享、AI副业分享、超200本经典计算机电子书籍等。

smart-doc 是一款同时支持 JAVA REST API 和 Apache Dubbo RPC 接口文档生成的工具。完全基于注释生成文档，做到零侵入。

smart-doc 最大的优点就在于零侵入，不采用任何注解侵入到业务代码中。

只需要按照 java-doc 标准编写注释，smart-doc 就能帮你生成一个简易明了的文档。

smart-doc 生成的文档支持 Markdown、Postman Collection2.0+、HTML5、OpenAPI 3.0+.

功能特性

此外，smart-doc 还支持自动推送文档到 Torna 企业级接口文档管理平台。

1、新建 JSON 配置文件

在项目启动类所在模块的 resources 目录下创建 smart-doc.json 文件：

outPath 指定文档输出的目录位置，也可以使用相对路径, 如: ./src/main/resources/static/doc

2、引入 Maven 插件依赖

如果是 Gradle 项目，同样的也需要引入插件：

Gradle 项目完整配置可参考：

3、使用

在 IDEA 中直接使用 Maven 插件目录下的 smart-doc 模块

smart-doc 模块

或者使用如下命令输出接口文档：

成功输出

不管是新项目，还是老项目，smart-doc 都完美适用。对于新项目不需要再引入其他框架和编写代码；老项目只要完善 java-doc 标准的注释，就可以快速生成接口文档，完全不影响到业务代码！

下次如果要编写接口接口文档，可以试试使用 smart-doc 一键生成~

当然了，smart-doc 也存在缺点，就是文档不是在线的，不利于分享！

针对于这一点，也有对应的解决方案，就是与企业级别的接口文档管理系统 Torna 结合。

最后，贴上项目地址：

推荐的开源项目已经收录到 GitHub 项目，欢迎 Star：

或者访问网站，进行在线浏览：

大家的点赞、收藏和评论都是对作者的支持，如文章对你有帮助还请点赞转发支持下，谢谢！

还在用Swagger？试试这款零注解侵入的API文档生成工具

前后端接口联调需要API文档，我们经常会使用工具来生成。之前经常使用Swagger来生成，最近发现一款好用的API文档生成工具smart-doc, 它有着很多Swagger不具备的特点，推荐给大家。

在我们使用Swagger的时候，经常会需要用到它的注解，比如@Api、@ApiOperation这些，Swagger通过它们来生成API文档。比如下面的代码：

Swagger对代码的入侵性比较强，有时候代码注释和注解中的内容有点重复了。有没有什么工具能实现零注解入侵，直接根据代码注释生成API文档呢？smart-doc恰好是这种工具！

smart-doc是一款API文档生成工具，无需多余操作，只要你规范地写好代码注释，就能生成API文档。同时能直接生成Postman调试文件，一键导入Postman即可调试，非常好用！

smart-doc具有如下优点：

接下来我们把smart-doc集成到SpringBoot项目中，体验一下它的API文档生成功能。

• 首先我们需要在项目中添加smart-doc的Maven插件，可以发现smart-doc就是个插件，连依赖都不用添加，真正零入侵啊；

• 接下来在项目的resources目录下，添加配置文件smart-doc.json，属性说明直接参考注释即可；

• 打开IDEA的Maven面板，双击smart-doc插件的smart-doc:html按钮，即可生成API文档；

• 此时我们可以发现，在项目的static/doc目录下已经生成如下文件；

• 运行项目，访问生成的API接口文档，发现文档非常详细，包括了请求参数和响应结果的各种说明，访问地址：http://localhost:8088/doc/index.html

• 我们回过来看下实体类的代码，可以发现我们只是规范地添加了字段注释，生成文档的时候就自动有了；

• 再来看下Controller中代码，我们同样规范地在方法上添加了注释，生成API文档的时候也自动有了；

• 当然smart-doc还提供了自定义注释tag，用于增强文档功能；
• @ignore：生成文档时是否要过滤该属性；
• @required：用于修饰接口请求参数是否必须；
• @since：用于修饰接口中属性添加的版本号。
• 为了写出优雅的API文档接口，我们经常会对返回结果进行统一封装，smart-doc也支持这样的设置，在smart-doc.json中添加如下配置即可；

• 我们也经常会用枚举类型来封装状态码，在smart-doc.json中添加如下配置即可；

• 配置成功后，即可在API文档中生成错误码列表；

• 有时候我们也会想给某些接口添加自定义请求头，比如给一些需要登录的接口添加Authorization头，在smart-doc.json中添加如下配置即可；

• 配置成功后，在接口文档中即可查看到自定义请求头信息了。

我们使用Swagger生成文档时候，是可以直接在上面测试接口的，而smart-doc的接口测试能力真的很弱，这也许是它拥抱Postman的原因吧，毕竟Postman是非常好用的接口测试工具，下面我们来结合Postman使用下！

• smart-doc内置了Postman的json生成插件，可以一键生成并导入到Postman中去，双击smart-doc:postman按钮即可生成；

• 此时将在项目的static/doc目录下生成postman.json文件；

• 将postman.json文件直接导入到Postman中即可使用；

• 导入成功后，所有接口都将在Postman中显示，这下我们可以愉快地测试接口了！

smart-doc确实是一款好用的API文档生成工具，尤其是它零注解侵入的特点。虽然它的接口测试能力有所不足，但是可以一键生成JSON文件并导入到Postman中去，使用起来也是非常方便的！

来源：https://mp.weixin.qq.com/s/ZbRYG-_AzDotnfgouv19NA

本文作者及来源:Renderbus瑞云渲染农场https://www.renderbus.com