大家接口文档都是怎么管理的。

V2EX = way to explore

V2EX 是一个关于分享和探索的地方

现在注册

已注册用户请登录

• 请不要在回答技术问题时复制粘贴 AI 生成的内容

这是一个创建于 2023 天前的主题，其中的信息可能已经有所发展或是发生改变。

我是公司后端开发，目前公司接口使用的是 word 记录，在 svn 上管理的。现在一个工程的接口文档到了快 200 页，电脑编辑保存下文档真是卡的不行。

想问下大家都是管理接口文档的，最好是离线的，公司不允许接口文档上外网。

文档

接口

上外网

svn

130 条回复 • 2021-10-12 10:03:22 +08:00

1 2

❮

❯

101

kenshinhu

2019-06-05 23:00:56 +08:00

apidoc + 1

102

zpf124

2019-06-06 09:08:01 +08:00

@changwei 你如果无聊的话, 你可以每天关注一下 v2 的 java 版块的话题.
然后你就能发现一只复读机, 涵盖了大部分话题, 只要话题和 ORM, http Server,Restful 这几个任意一个有一丁点关联, 他都会自说自话到他的 APIJSON.

你要是单纯听他吹,感觉他一个项目比 Spring 全部项目都万能. 除了不能生孩子没有他的的框架做不了的.

103

serge001

2019-06-06 09:18:57 +08:00

eolinker+1

104

ideaa

2019-06-06 09:19:21 +08:00

PHP 的话可以写在注释里，扫描控制器类目录反射获取注释内容就可以了，几年前就一直这样用，很方便

105

mezi04

2019-06-06 09:38:26 +08:00

@zsdroid yapi 编辑的时候会感觉很卡嘛？我现在就用的这个，编辑的时候就感觉特别的卡，不知什么原因

106

TommyLemon

2019-06-06 10:16:24 +08:00

@zpf124 "一个项目比 Spring 全部项目都万能. 除了不能生孩子没有他的的框架做不了的."
这是你帮我吹的吧？不要误导新人了，都去看看发帖纪录好了
https://www.v2ex.com/tag/apijson

107

tiedan

2019-06-06 10:30:04 +08:00

apib

108

Macolor21

2019-06-06 10:58:54 +08:00

@changwei 因为有些人已经 block 了，都能知道他还在这里发，不否认他的开源精神，厌恶这种运营方式。

109

wongy

2019-06-06 11:17:21 +08:00

eolinker

110

tt67wq

2019-06-06 11:25:56 +08:00

@TommyLemon #26 非 java 能用不啦

111

TommyLemon

2019-06-06 14:30:36 +08:00

@Macolor21 无非是猜的，block 了压根看不到

112

TommyLemon

2019-06-06 14:36:53 +08:00

@tt67wq
自动化接口管理工具 APIJSONAuto ？
类似 Postman，和语言无关，不侵入代码，任何语言都支持的。

自动化接口与文档 ORM 库？
提供 Node(TypeScript), Python, PHP, Java, C#, Go 后端库 + Android,iOS,JavaScript,Vue 的前端(客户端) Demo

113

TommyLemon

2019-06-06 14:37:48 +08:00

@TommyLemon
自动化接口管理工具 APIJSONAuto ？
类似 Postman，和语言无关，不侵入代码，任何语言都支持的。

自动化接口与文档 ORM 库 APIJSON ？
提供 Node(TypeScript), Python, PHP, Java, C#, Go 后端库 + Android,iOS,JavaScript,Vue 的前端(客户端) Demo

GitHub 上都能搜到，或者随便谷歌，百度等搜索下都能找到

114

TommyLemon

2019-06-06 14:41:13 +08:00

@changwei Vue 也是一堆人喷，不用管喷子，只看项目是否适合自己，提升效率，用得舒服就行了