技术解析

API 文档大家是怎么生成的?
0
2021-06-09 15:23:30
idczone
java 写的 web 服务, 要给前端提供接口文档, 问下大家都是怎么生成的?
现在业内国外服务器实践用的都是啥?
swagger

用过楼上的,挺好的

https://github.com/YMFE/yapi

openapi, swagger

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

swagger

难道就我一个人手写吗?

如果 python 的话,fastapi 很不错。

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

swagger 能够快速生成。
showdoc

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

可以用易文档编写 https://easydoc.xyz ,它也可以一键生成文档,也可以从注释生成文档。预览效果: https://www.easydoc.xyz/s/17790664
截图
https://i.loli.net/2021/03/10/jVQdKMkJ4FPevui.png

手写

swagger

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

手写+1

yapi docker 手写

swag

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

swagger

swagger 然后 用 redoc 展示

swagger+插件直接变 doc

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

swagger,部分生成不了的用 docfx

只有我用 gitbook 吗?

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

apidoc

yapi

https://github.com/star7th/showdoc

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

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

apidoc

我记得 fastapi 用的也是 swagger

对接的给我一个 swagger

swagger+yapi

md 手写 、YAPI

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

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

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

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

swagger 然后自动同步到 yapi

restdoc

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

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

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

swagger + yapi,永远滴神

md 手写

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

md 手写

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

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

每次 API 有啥修改 就发一份 word 文档
真是 不好吐槽

swagger

yapi

没人用 RAP 吗

https://apicat.net

yapi

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

swagger 或者 knife4j

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

swag /:狗头

俺也用...

swagger + yapi

写 protobuf 然后生成 swagger

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

实习生写

铁子, nb

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

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)

手写

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

postman......

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

必须推荐 showdoc,用过的都说好。

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

Swagger UI 感觉不是很好看,有没有其他替代?(除了 yapi )

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

语雀

易文档可以看下,真好用

那肯定还没用过易文档

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

能问下,你用的是哪个 yapi docker 镜像

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

数据地带为您的网站提供全球顶级IDC资源
在线咨询
专属客服