使用showdoc生成接口文档

今天在编写使用cxf开发restful接口的同时,发现了一个生成接口文档的一个工具,比较好用,这里记录下笔记。以 生成一个restful接口文档 为例。

  1. showdoc官网地址 https://www.showdoc.cc/
  2. 点击右上角的【登录/注册】,注册账号
  3. 登录进入showdoc
  4. 新建项目使用showdoc生成接口文档
  5. 使用showdoc生成接口文档
  6. 使用showdoc生成接口文档
  7. 使用showdoc生成接口文档
  8. 使用showdoc生成接口文档
  9. 使用showdoc生成接口文档
  10. 复制生成的markdown格式的文档,回到本文中的第6步,将文档粘贴到左边文本域使用showdoc生成接口文档
  11. 然后点击右上角的保存按钮。
  12. 然后就可以通过https://www.showdoc.cc/zidingyi来访问刚刚生成的接口文档