采用团队协作的方式管理和维护接口文档,将不同形式的文档纳入进来统一维护 接口文档解决方案,目标是让接口文档管理变得更加方便、快捷
接口文档解决方案,目标是让接口文档管理变得更加方便、快捷。采用团队协作的方式管理和维护接口文档,将不同形式的文档纳入进来统一维护。
弥补了传统文档生成工具(如swagger)的不如之处,在保持原有功能的前提下丰富并增强了一些实用的功能。
采用团队协作的方式管理和维护接口文档,将不同形式的文档纳入进来统一维护 接口文档解决方案,目标是让接 ...
解决文档管理痛点- 不满足swagger文档预览页面和调试页面的展现方式
- 不喜欢swagger这种侵入式注解
- 希望使用javadoc注释生成文档,并进行接口调试
- 希望把公司所有项目接口文档进行统一管理
- 希望把项目中的若干文档提供给第三方调用者查看
- 希望可以统一管理项目中的字典枚举
如果您有以上几个需求和痛点,或许可以尝试一下使用 使用步骤方式
1:下载zip本地运行准备工作
- Java环境,最低要求Java8
- MySQL,要求5.6.5及以后,5.6.5之前的版本见:支持低版本MySQL
前往 发行版页面 ,下载最新版本,解压zip 导入数据库,执行mysql.sql 打开application.properties配置文件,修改数据库连接配置 执行sh startup.sh启动(Windows执行startup.bat) 访问:http://ip:7700 用户名:admin,密码:123456 无特殊说明,只需要覆盖.jar文件和dist文件夹,然后重启即可
smart-doc + 实现文档全流程自动化 如果您使用Java语言,推荐使用smart-doc + 整合smart-doc教程 smart-doc + 组成行业领先的文档生成和管理解决方案,使用smart-doc无侵入完成Java源代码和注释提取生成API文档,自动将文档推送到Torna企业级接口文档管理平台。 通过这套组合您可以实现:只需要写完Java注释就能把接口信息推送到平台,从而实现接口预览、接口调试。 如果您是非Java语言,可以使用表单页面编辑以上内容,完成后同样可以进行接口预览、调试。
采用团队协作的方式管理和维护接口文档,将不同形式的文档纳入进来统一维护 接口文档解决方案,目标是让接 ...
采用团队协作的方式管理和维护接口文档,将不同形式的文档纳入进来统一维护 接口文档解决方案,目标是让接 ...
采用团队协作的方式管理和维护接口文档,将不同形式的文档纳入进来统一维护 接口文档解决方案,目标是让接 ...
采用团队协作的方式管理和维护接口文档,将不同形式的文档纳入进来统一维护 接口文档解决方案,目标是让接 ...

链接:https://pan.quark.cn/s/640da855dc00
提取码下载:
|