使用yapi工具編輯接口文檔

相對于swagger來說，yapi頁面更加美觀，使用上功能也更多了一些，所以操作也相對復雜，上文安裝完yapi后，本文將介紹如何使用 yapi。

1.建立文檔地址

1.新建分組

在多組同時使用時，可以按照小組對文檔進行分類。

2.在分組中建立項目

在小組內新建項目文件夾。

3.進入項目后添加分類

在項目中按照業務類別新建分組。

2.編寫接口文檔

在編寫接口文檔的過程中，有四種方式。分別為手動編寫，從postman導入，從swagger導入，通過idea生成。這樣大大豐富了在日常使用中的靈活程度。下文將一一介紹。

1.手動編寫

這種方式就是手動在系統中填寫，比價繁瑣。

在編輯中手動填寫。

2.導入postman文檔

首先從postman中導出json文檔。

注意，這里需要選擇1.0選項。

導入上文的json文件。

3.使用swagger導入

我們也可以選擇同步swagger的文檔，首先選擇同步模式 。url為swagger地址 例 http://ip:8001/system/v2/api-docs。

當同步完成后，可以在頁面中看到已經導入的接口文檔。

4.使用idea插件

同時也可以連接idea通過配置生成接口文檔。

每個項目都有一個token，所以多項目的token是不同的。

按照說明配置即可。

在接口上點擊idea-yapi即可生成。

IDE

版權聲明：本文內容由網絡用戶投稿，版權歸原作者所有，本站不擁有其著作權，亦不承擔相應法律責任。如果您發現本站中有涉嫌抄襲或描述失實的內容，請聯系我們jiasou666@gmail.com 處理，核實后本網站將在24小時內刪除侵權內容。