一个更好用的 API 文档解决方案

2024-01-11 17:11:15 +08:00
 kalman03

Apideploy是一个一站式的 API 生成、托管、调试与协同解决方案。其核心分为两部分：API 文档生成 +API 托管与调试平台。

API 文档生成是一个自动化的过程，同时支持“基于代码注释文档生成”与“基于 Swagger / OpenAPI 文档生成”， 目前提供了 Java 生成的开源代码，访问 https://github.com/apideploy-team 可以查阅。

API 托管与调试平台主要功能包括：项目管理、团队协作、权限管理、API 文档托管、文档调试、接口数据 mock 、版本更新记录、版本对比、个性化文档导出、多格式文档导入等，是一个集 API 全生命周期管理的平台，非常适合团队协作。目前支持公有云与私有化部署，www.apideploy.com 是公有云的解决方案。

有任何问题可以反馈

7404 次点击
所在节点    分享创造
19 条回复
est
2024-01-11 17:19:26 +08:00
文档工具发明这么多，前后端分离是不是走了弯路。
kalman03
2024-01-11 17:43:49 +08:00
@est 你引发了我更深入的思考
est
2024-01-11 21:07:20 +08:00
@kalman03 哈哈哈哈。
dc2002007
2024-01-12 09:37:11 +08:00
@est 最大的弯路是把前后端的工种分开了，技术分离我是支持的，前端不懂后端，后端不懂前端，配合起来很不默契，一件完整的事情非要两个人干，前后都是 crud 的级别，却还要两个人来共同完成，这是人才的浪费，但也提供了更多的就业岗位。
wu00
2024-01-12 09:49:22 +08:00
@dc2002007 不敢苟同。
分不分也得看场景，小项目肯定是一把梭最合适。
上了点规模的项目，不光要分前后端，甚至前后端之间还有一个中间层专门处理接口聚合、转换工作。
就跟你写代码一样，复杂的代码肯定是要做抽离/加中间层来解耦、聚合、单一...
本质上还是工厂流水线那一套
dc2002007
2024-01-12 09:55:37 +08:00
@wu00 接口聚合、转换工作/抽离/加中间层来解耦、聚合、单一，这些都是工作，不是工种，如果是全栈团队的话，划分好任务，每个人都可以做到你说的流线的一部分，流水线最重要的目的是把任务划分到最小颗粒，最大程度的弱化工种的划分，我并不在乎你是否苟同我的观点！
gbw1992
2024-01-12 10:15:34 +08:00
根据楼上说的，吐个槽
难道前后端最完美的方案是代码生成器么
真就是回旋镖啊
amon
2024-01-12 11:18:30 +08:00
同类产品有点多，眼花缭乱，
一个个试用太麻烦，我的时间很有限，
建议出个短视频，快速 get 到核心点，
哦耶✌️，你就是 API 文档解决最佳方案。
est
2024-01-13 11:10:14 +08:00
@gbw1992 文档生成到极致就是代码生成。代码生成到极致就是后端全部渲染。前端留一个 canvas 渲染就行了。。233333 。。。。
shalk
2024-01-25 15:16:58 +08:00
apideploy-java-client 的作用就上传 yaml 么。。。没看到代码生成。
另外服务端的代码不开源么，感觉和 swagger 差不多
kalman03
2024-01-25 16:01:53 +08:00
@shalk 是的，上传了 openAPI 的 json 数据。 页面展示的部分没有开源，严格来说是一个基于 openAPI 来做的更好看的 UI ，但是集成了版本管理、接口 mock 、直接 debug 测试、团队协作与权限管理等系列功能。
BenX
2024-02-08 15:50:05 +08:00
貌似不是全部开源的
kalman03
2024-02-13 23:28:44 +08:00
@BenX 后台管理 UI 部分，因为并没有前后端分离，所以写的还比较“抽象”，到时整理下再放出来。
tyzandhr
2024-02-13 23:57:56 +08:00
@dc2002007 API 的本质是 model 的传递，所以 model 应该由专人负责，专门维护前后端的 API
kalman03
2024-02-14 00:27:29 +08:00
@tyzandhr 对外的可以这样，比如开放平台服务类性质的。但是，在业务 API 的开发过程中，这个迭代速度是非常快的，不适合专门去维护，通过持续集成（ CI/CD ）的方式个人感觉是一种较优雅的方案。
jorneyr
2024-02-14 12:20:49 +08:00
前后端项目可以分离，但人不能分离，要不改个接口，设计得沟通好久。
kalman03
364 天前
@jorneyr 是的，所以 apideploy 是一种好的选择。
xwwsxp
361 天前
前后端分离最大的好处，就是在开发和部署阶段，不需要后端介入了；想想以前的 JSP 等，都是眼泪~
forty
359 天前
@xwwsxp JSP 我玩过, 也一样前后端分离的.

这是一个专为移动设备优化的页面（即为了让你能够在 Google 搜索结果里秒开这个页面），如果你希望参与 V2EX 社区的讨论，你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://tanronggui.xyz/t/1007879

V2EX 是创意工作者们的社区，是一个分享自己正在做的有趣事物、交流想法，可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX