當(dāng)有接口對(duì)接需求的時(shí)候，開(kāi)發(fā)終于不用再擔(dān)心 API 文檔難寫(xiě)了，也不用再一個(gè)個(gè)接口文檔重新寫(xiě)！安裝這個(gè) IDEA 插件，可以一步將文檔導(dǎo)入到 Postcat。
這款插件操作簡(jiǎn)單，容易上手，能夠讓開(kāi)發(fā)者省去API文檔編寫(xiě)的工作，更專注于開(kāi)發(fā)。插件通過(guò)分析用戶注釋進(jìn)行接口解析，最終生成接口文檔并上傳至 Postcat 服務(wù)器，使得開(kāi)發(fā)者可以在 Postcat 上進(jìn)行 API 管理和分享，提高協(xié)作能力和開(kāi)發(fā)速度。
?
和Swagger 有什么區(qū)別呢？
Postcat 插件不會(huì)入侵到代碼內(nèi)部，無(wú)需添加任何jar包依賴
插件通過(guò)分析用戶注釋進(jìn)行接口解析，最終生成接口文檔并上傳至 Postcat 服務(wù)器，使得開(kāi)發(fā)者可以在 Postcat 上進(jìn)行 API 管理和分享，提高協(xié)作能力和開(kāi)發(fā)速度。
Postcat 提供了多種拓展注釋，如@path、@url、@method、@name、@hidden和@required，這些注釋可以在設(shè)置界面進(jìn)行自定義或兼容現(xiàn)有注釋。
此外，Postcat 還提供了注釋生成功能，對(duì)于沒(méi)有或僅有少量注釋的類和方法，開(kāi)發(fā)者無(wú)需費(fèi)力手動(dòng)添加，該功能可以分析方法字段含義并自動(dòng)生成注釋。開(kāi)發(fā)者只需要檢查或根據(jù)實(shí)際場(chǎng)景進(jìn)行微調(diào)，即可生成一份較完善的API文檔。
如果原有注釋不足，Postcat 會(huì)通過(guò)添加方式補(bǔ)充注釋，移除注釋時(shí)只會(huì)移除Postcat提供的那些拓展性注釋，不會(huì)破壞用戶自身的注釋。同時(shí)，開(kāi)發(fā)者還可以使用"意圖"功能局部生成插件注釋，并進(jìn)行調(diào)整和修改。
Postcat提供了多種 API 上傳方式，方便開(kāi)發(fā)者在不同的場(chǎng)景下使用：
-
對(duì)于首次使用Postcat的現(xiàn)有項(xiàng)目，開(kāi)發(fā)者可以使用主菜單中
Tools分組下的Upload Project Api Doc來(lái)完成項(xiàng)目級(jí)別的接口上傳。 -
對(duì)于新需求下創(chuàng)建的Controller，在完成接口定義后，開(kāi)發(fā)者可以右鍵菜單，選擇
Upload All Api來(lái)進(jìn)行單個(gè)文件級(jí)別全部上傳，做到先有文檔再有邏輯，前后端工作不再串行阻塞。 -
對(duì)于某個(gè)部分單獨(dú)接口的改動(dòng)，無(wú)需全部上傳，開(kāi)發(fā)者可以右鍵菜單，選擇
Upload Api功能，該功能會(huì)展示當(dāng)前編輯類的接口信息，并提供接口預(yù)覽和接口選擇界面，使得用戶可以勾選需要更新或上傳的目標(biāo)API進(jìn)行信息核對(duì)和上傳。
好了，如果你對(duì)這個(gè)插件感興趣，不妨去市場(chǎng)搜一搜，覺(jué)得項(xiàng)目還不錯(cuò)的話，不妨Star 支持一波！
Github ：文章來(lái)源：http://www.zghlxwxcb.cn/news/detail-421565.html
https://github.com/Postcatlab/postcat文章來(lái)源地址http://www.zghlxwxcb.cn/news/detail-421565.html
到了這里，關(guān)于裝上這個(gè)插件，你就能一鍵生成接口文檔的文章就介紹完了。如果您還想了解更多內(nèi)容，請(qǐng)?jiān)谟疑辖撬阉鱐OY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！
