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

資深大佬 : asanelder 9

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

大佬有話說 (81)

資深大佬 : 18519017871

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
資深大佬 : sss495088732

yapi docker 手写
資深大佬 : jowan

swag
資深大佬 : zhaorunze

我还以为手写了个框架，仔细一想，可能是手写文档。。。
資深大佬 : ghouleztt

swagger
資深大佬 : Molita

swagger 然后用 redoc 展示
資深大佬 : 15190049162

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
資深大佬 : hjahgdthab750

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

swagger 或者 knife4j
資深大佬 : YadongZhang

RESTful API，只有我用 Postman 写文档吗。。。
資深大佬 : salenpeng

swag /:狗头
資深大佬 : hakr

@YadongZhang #60 俺也用…
資深大佬 : freebird1994

swagger + yapi
資深大佬 : liuw666

写 protobuf 然后生成 swagger
資深大佬 : liuw666

使用 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

![aF2vk5-L5pmGt]( https://cdn.jsdelivr.net/gh/liuzhihang/oss/pic/article/aF2vk5-L5pmGt.png)
資深大佬 : Cbdy

手写
資深大佬 : liuzhihang

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

postman……
資深大佬 : dcatfly

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

@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 那肯定还没用过易文档
資深大佬 : vfxx

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