使用showdoc生成接口文檔

今天在編寫使用cxf開發restful接口的同時,發現了一個生成接口文檔的一個工具,比較好用,這裏記錄下筆記。以 生成一個restful接口文檔 爲例。

  1. showdoc官網地址 https://www.showdoc.cc/
  2. 點擊右上角的【登錄/註冊】,註冊賬號
  3. 登錄進入showdoc
  4. 新建項目
  5. 複製生成的markdown格式的文檔,回到本文中的第6步,將文檔粘貼到左邊文本域
  6. 然後點擊右上角的保存按鈕。
  7. 然後就可以通過https://www.showdoc.cc/zidingyi來訪問剛剛生成的接口文檔
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章