跳至主要內容
  • Hostloc 空間訪問刷分
  • 售賣場
  • 廣告位
  • 賣站?

4563博客

全新的繁體中文 WordPress 網站
  • 首頁
  • 写 api 文档的工具
未分類
19 5 月 2020

写 api 文档的工具

写 api 文档的工具

資深大佬 : hwlhwlxyz 0

问一下有没有好用的写 api 文档的工具?就两个人写,感觉 swagger editor 写起来太复杂了。大家一般都用什么呢?
大佬有話說 (33)

  • 資深大佬 : xsir

    yapi

  • 資深大佬 : dullwit

    https://github.com/slatedocs/slate

  • 資深大佬 : qinxiao

    md 一把梭

  • 資深大佬 : LoNeFong

    excel /狗头

  • 資深大佬 : ytmsdy

    showdoc 吧,感觉用来写文档挺好用的。

  • 資深大佬 : hnbcinfo

    YApi,然后项目里,自定义几个 Attribute,用在接口和 Dto 字段上,通过反射获取接口和参数信息,自动更新解析到 Yapi 。懒人必备,同时也省去了接口更新后忘了更新文档的麻烦。

  • 資深大佬 : balabalaguguji

    易文档很好用,专门写接口文档的 https://easydoc.xyz

    ![preview.png]( https://i.loli.net/2020/05/18/MNR3yb1KOthnsuI.png)

  • 資深大佬 : lizz666

    https://easydoc.xyz/

  • 資深大佬 : linauror

    目前在用 markdown,感觉写起来自在一点

  • 資深大佬 : Rwing

    相信我,如果不用一款自动生成文档的工具,那么没人愿意去”写“文档

  • 資深大佬 : putaozhenhaochi

    Rap2

  • 資深大佬 : Elephant696

    /mar/kdown

  • 資深大佬 : Xezzon

    在线 NEI,本地部署 YApi 。

  • 資深大佬 : shuang

    不推荐 Rap2
    强烈推荐 YApi

  • 資深大佬 : thet

    之前用 eolinker 在线的,还可以

  • 資深大佬 : Heanes

    yapi,或者注解自动生成

  • 資深大佬 : anaf

    sphinx-doc

  • 資深大佬 : 5G

    自己造轮子 ing

  • 資深大佬 : aaaafei

    还没试过 yapi,试过易文档,感觉还可以

  • 資深大佬 : narmgalaxy

    YApi

  • 資深大佬 : mylxsw

    写 API 文档可以在代码中使用 Swagger 来生成,一般语言都有相关的库可以使用,嫌麻烦可以直接使用 Markdown 来写。

    推荐 Wizard,仓库地址 https://github.com/mylxsw/wizard,同时支持 Markdown 和 Swagger 两种类型的文档。

  • 資深大佬 : blackhumorly

    Yapi

  • 資深大佬 : hantsy

    asciidoc

  • 資深大佬 : ChoateYao

    推荐 RAP2 的都是没有深度使用的,就 RAP2 这种一次性加载几 M 数据十秒+的软件也能拿出来吹

  • 資深大佬 : fanyingmao

    我之前是用 apidoc 比较轻量级,写在注释中

  • 資深大佬 : crs0910

    https://insomnia.rest/

  • 資深大佬 : yutonliu

    showdoc

  • 資深大佬 : qile1

    @yutonliu
    @ytmsdy 这个现在需要手机注册验证了,之前 qq 登录没问题,写了一堆文档,突然有一天让验证手机了,连缓存都没有!

    已经放弃

  • 資深大佬 : Xusually

    @qile1 自己部署私有的就行了。

  • 主 資深大佬 : hwlhwlxyz

    手写 markdown 也是可以,就是有的时候翻起来比较麻烦点。Yapi 看起来好强大啊,我去试试看。

  • 主 資深大佬 : hwlhwlxyz

    看了下,就两个人的话,showdoc 也挺好用,还好项目不大的。谢谢大家的回复。

  • 資深大佬 : iacker

    语雀,用后你会回来感谢我的~

  • 資深大佬 : cz5424

    yapi 不能生成对外的文档..

文章導覽

上一篇文章
下一篇文章

AD

其他操作

  • 登入
  • 訂閱網站內容的資訊提供
  • 訂閱留言的資訊提供
  • WordPress.org 台灣繁體中文

51la

4563博客

全新的繁體中文 WordPress 網站
返回頂端
本站採用 WordPress 建置 | 佈景主題採用 GretaThemes 所設計的 Memory
4563博客
  • Hostloc 空間訪問刷分
  • 售賣場
  • 廣告位
  • 賣站?
在這裡新增小工具