API 文档大家是怎么生成的?

[asanelder]

java 写的 web 服务, 要给前端提供接口文档, 问下大家都是怎么生成的?
现在业内实践用的都是啥?

看来主流还是 swagger 和 yapi 啊

俺看了一下, 俺的服务不到 10 个接口, 也很简单

所以, 最终, 俺用的方式是







使用 markdown, 手工

感谢铁子们推荐, 等接口复杂了, 再研究你们的工具

[alanhe421]

swagger

[sunziren]

用过楼上的，挺好的

[gageshan]

https://github.com/YMFE/yapi

[knightdf]

openapi, swagger

[wolfie]

md 手写，生成的除了自己很难看，而且涉及到字段改动怎么标注。

[lungank]

swagger

[rationa1cuzz]

难道就我一个人手写吗？

[hanssx]

如果 python 的话，fastapi 很不错。

[zlhsvc]

手写，之前用过脚本总觉得差了点

[yiqiao]

swagger 能够快速生成。
showdoc

[acmore]

swagger
Java 生态下也可以考虑 Spring Rest Docs

[balabalaguguji]

可以用易文档编写 https://easydoc.xyz ，它也可以一键生成文档，也可以从注释生成文档。预览效果： https://www.easydoc.xyz/s/17790664

截图
https://i.loli.net/2021/03/10/jVQdKMkJ4FPevui.png

[liuzhaowei55]

手写

[bigpigeon]

swagger

[bigpigeon]

写了一个通过 go 框架生成 swagger 代码的 api，只要实现 api 就能自动生成 swagger

[SjwNo1]

手写+1

[cocowind]

yapi docker 手写

[jowan]

swag

[zhaorunze]

我还以为手写了个框架，仔细一想，可能是手写文档。。。

[ghouleztt]

swagger

[Molita]

swagger 然后 用 redoc 展示

[NoneUndefined]

swagger+插件直接变 doc

[mcfog]

重要的不是怎么生成，而是数据源在哪里，怎么管理

[h82258652]

swagger，部分生成不了的用 docfx

[oneend]

只有我用 gitbook 吗？

[www5070504]

swagger 只要增加几行注释 很好用..

[a62527776a]

apidoc

[Rekkles]

yapi

[star7th]

https://github.com/star7th/showdoc

[journalistFromHK]

上一家公司，老板写 java，啥是文档？不存在的，自己去看 controller 吧

[so1n]

自己写了一个库来自动生成 https://github.com/so1n/pait

[henryhu]

apidoc

[UN2758]

@hanssx #8 我记得 fastapi 用的也是 swagger

[KisekiRemi]

对接的给我一个 swagger

[cat007]

swagger+yapi

[AngryPanda]

md 手写 、YAPI

[evam]

postman 自己调试接口，然后 postman 分享，coding 自动生成

[egfegdfr]

smart-doc
感觉 swagger 的侵入性太强了

[jorneyr]

不喜欢 swagger 这种污染源码的工具，更喜欢用 yApi 这种类似的工具进行管理。

[xuanbg]

@wolfie md 手写+1，也就是模版上面复制粘贴，一点都不费事。swagger 实在是太丑

[monkeyWie]

swagger 然后自动同步到 yapi

[scxiazi]

restdoc

[putaozhenhaochi]

借楼问下，各位是先定义接口 还是先写代码

[MarioLuo]

YapiIdeaUploadPlugin IDEA 插件基于 JavaDoc 注释生成文档，上传到 yapi 中.

[xnotepad]

自己写了个 https://apidoc.tools

[chogath]

swagger + yapi，永远滴神

[newmlp]

md 手写

[offswitch]

@putaozhenhaochi 通常的说法是先写定义再写代码，不过大部分公司根本就没这要求，爱咋咋

[alienx717]

md 手写

[XCFOX]

目前用过最舒服的是 GraphQL 。文档和接口无缝结合。接口还是强类型的。前端能直接根据 graphql 接口地址生成接口类型

[20200924]

作为前端人员，感觉看 yapi 比看 swagger 舒服很多

[justin2018]

每次 API 有啥修改 就发一份 word 文档

真是 不好吐槽

[54xavier]

swagger

[sannyzeng]

yapi

[fuyangyishi0]

没人用 RAP 吗

[Gunn27]

https://apicat.net

[guiling]

yapi

[qW7bo2FbzbC0]

因为 go 没有便捷的 swagger 工具，我转 spring 这种插件成熟的框架了

[yang2048]

swagger 或者 knife4j

[zhyd1997]

RESTful API，只有我用 Postman 写文档吗。。。

[salenpeng]

swag /:狗头

[hakr]

@YadongZhang #60 俺也用...

[freebird1994]

swagger + yapi

[nowtg]

写 protobuf 然后生成 swagger

[nowtg]

使用 protobuf 定义，只要想改接口参数，proto 就必须修改，swagger 肯定也是最新的

[ERRASYNCTYPE]

实习生写

[asanelder]

@ERRASYNCTYPE #66 铁子, nb

[m1ch3ng]

smart-doc，靠 javadoc 就能自动生成

[liuzhihang]

IDEA 插件 Doc View 纯 markdown 。不知道能不能满足你的需求。也欢迎 v2 小伙伴提 PR

https://github.com/liuzhihang/doc-view


[Cbdy]

手写

[liuzhihang]

发不出来图…… 看链接吧 https://plugins.jetbrains.com/plugin/15305-doc-view

[noyidoit]

postman......

[dcatfly]

yapi 竟然有 1k+的 issue 没关闭，最近在用它内部的组件，代码写的一言难尽。。让我觉得这个项目还没死也是不容易。。

[ccvip]

@star7th 必须推荐 showdoc，用过的都说好。

[ArrayBuffer]

我是前端, 对我来说最好的还是 `swagger` / `graphql`; `swagger` 是比较成熟的, 但对于阅读者来说还是有些地方体验不是很好, 为此我写了个脚本 greasyfork.org/zh-CN/scripts/401581, `graphql` 我也写了 greasyfork.org/zh-CN/scripts/416677

[xcatliu]

Swagger UI 感觉不是很好看，有没有其他替代？（除了 yapi ）

[feitxue]

swagger 增强 ui 后的 knife4j,会舒服一点.

[zaul]

语雀

[balabalaguguji]

@xcatliu #76 易文档可以看下，真好用

[balabalaguguji]

@vfxx #74 那肯定还没用过易文档

[ccvip]

我一直是用的 showdoc 私有化部署，易文档部署价格 8K，要不起。。。 易文档免费版竟然不支持导出

[liuliangsir]

@sss495088732 能问下，你用的是哪个 yapi docker 镜像

[cocowind]

@liuliangsir https://github.com/silsuer/yapi-docker

[smartdoc647]

smart-doc+torna，目前开源产品中国内最成熟的，科大讯飞和顺丰这些公司都在用，不是吹出来的。