好看的Spring項目文檔生成工具-MiApiDoc(2)

好看的Spring項目文檔生成工具-MiApiDoc(1)已經介紹瞭如何在Spring項目中利用代碼生成文檔了,該篇文章將會介紹生成文檔後的web網頁的使用。

文件介紹

運行java代碼後,會生成至少2個文件,一個是listConfig.json,該文件主要保存的是目錄配置的信息,名稱不能被更改,其他的是已.json結尾的文件,該文件爲保存Api接口數據的,一般由用戶定義名稱。
在這裏插入圖片描述

快捷功能介紹

1.在用戶未選中任何文字時,按下Ctrl+V,將會複製當前Api接口的Url。
2.點擊參數名稱即可複製該參數名。

在這裏插入圖片描述

3.點擊Header Body可複製所有的參數名稱。

在這裏插入圖片描述在這裏插入圖片描述

功能介紹

1. 目錄

目錄主要用來區分不同功能接口的大分組,比如‘用戶端接口、後臺管理端接口’。

2.列表

列表主要用來顯示分組、Api接口,當文檔有新接口或者Api接口更新過的話,會有對應的提示。
在這裏插入圖片描述

3.右側展示區介紹

展示區會將最近打開的Api接口保留,可快速切換。
展示區主要顯示該Api接口的介紹、url、請求參數、備註、返回示例以及模擬請求。

4.模擬請求

點擊模擬請求後,將會讀取該Api接口的默認配置的header、body參數進行帶參請求,用戶可更改值後模擬請求,不需要其中某個參數時可將前面√去除。請求成功後,數據會在請求結果版面實現。
在這裏插入圖片描述

5.頂部欄介紹

頂部欄搜索框可輸入Api的關鍵字以及Api的url進行搜索。
用戶可選擇切換不用用戶身份進行請求,選擇的用戶如果配置了header參數,將會在模擬請求時一同跟隨請求,如遇到相同字段則會根據用戶配置來進行選擇保留。
點擊設置圖標可打開設置頁面,設置頁面目前有請求設置、用戶管理兩個功能,這兩個功能下面介紹。在這裏插入圖片描述

6.請求設置

請求設置可設置全局請求默認header參數,設置後每一次模擬請求都會跟隨請求,通過用戶自行配置,如遇到相同字段則會根據用戶配置來進行選擇保留。如不需要其中某個字段,可將啓用狀態關閉或者刪除該header字段即可。
在這裏插入圖片描述

7.用戶管理

其實用戶功能類似上面的請求設置,如果你選擇了某個用戶,這個用戶下面的header參數也將會跟隨模擬請求一併帶參請求。
該功能主要目的是可以設置不同的用戶身份,滿足不同用戶身份自由切換,而不用每次模擬請求都要手動設置用戶身份的參數。
填完用戶後可在頂部欄選擇是否使用該用戶,如不需要該用戶,選擇‘不選擇用戶’即可,或者直接刪除該用戶身份。
在這裏插入圖片描述

好了,目前上面就是MiApiDoc的web網頁的使用介紹了,如果你有更好的想法,歡迎留言反饋,如果遇到bug請麻煩立即反饋哦,該項目會一直更新的!

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章