資訊專欄INFORMATION COLUMN
摘要：首先是從下載了，這個(gè)已經(jīng)能夠生成和文檔了，但是對中文支持不好，中文大部分會顯示為空白。關(guān)于這個(gè)對中文支持不好，查了很多資料，應(yīng)該是字體和主題的原因，所以參考了很多資料，結(jié)合當(dāng)前這個(gè)，做出了最終的能很好支持中文的，最終地址。
做后端開發(fā)，自然離不開接口文檔，接口文檔不僅方便后端開發(fā)人員之間查看，更是前端人員必要的文檔，也有可能提供給第三方來調(diào)用我們的接口。但是，寫接口文檔太費(fèi)時(shí)間，而且如果沒有確定好格式，每個(gè)人寫的接口文檔可能各不相同，看起來就會很混亂。
好在swagger出現(xiàn)了，如果你的spring boot項(xiàng)目集成了swagger，而且接口和入?yún)⒊鰠?shí)體類加上了swagger相關(guān)的注解(參考最終demo中的controller和model)，那么，就可以通過http://ip:port/swagger-ui.html(ip和port換成自己配置的)來訪問在線的接口，在此頁面也可以直接測試接口。對spring boot和swagger不了解的建議先學(xué)習(xí)一下，近年來很火，使用起來也確實(shí)方便。但是我們肯定不會滿足在線訪問就可以了的，有時(shí)候會需要離線的接口文檔，于是就有了swagger2markup、springFox、asciidoctor幾個(gè)插件來幫助我們生成離線的HTML和PDF格式的文檔。
關(guān)于使用swagger生成HTML或者PDF的原理，可以參考這篇文章：使用 SpringFox、Swagger2Markup、Spring-Restdoc和 Maven 構(gòu)建 RESTful API文檔。
首先是從spring-swagger2markup-demo下載了demo，這個(gè)demo已經(jīng)能夠生成HTML和PDF文檔了，但是對中文支持不好，中文大部分會顯示為空白。如果你的接口文檔是全英文的，那么就用這個(gè)就可以了。關(guān)于這個(gè)demo對中文支持不好，查了很多資料，應(yīng)該是字體和主題的原因，所以參考了很多資料，結(jié)合當(dāng)前這個(gè)demo，做出了最終的能很好支持中文的demo，最終demo地址：swagger2pdf。
生成的文檔存放的目錄：當(dāng)前項(xiàng)目的targetasciidochtml和targetasciidocpdf分別存放著HTML文檔和PDF文檔。
關(guān)于接口和入?yún)⒊鰠?shí)體類中用到的swagger注解，可以參考這篇博客：swagger2常用注解說明。
最終生成的HTML文檔和PDF文檔效果圖：
由于參考了很多資料都沒有成功，只記錄了最后成功的鏈接，沒有記錄下其他的鏈接，如果您覺得其中有參考您的部分，可以留言留下您的地址，我會加到參考的鏈接里的。
主要參考：
https://github.com/Swagger2Ma...
https://blog.csdn.net/lihuaij...
https://github.com/woshihouji...
文章版權(quán)歸作者所有，未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請注明本文地址：http://m.hztianpu.com/yun/73713.html
摘要：沒錯(cuò)，不支持，從導(dǎo)出的文檔也可以看到，部分中文無法顯示，目前我也尚未找到是否有配置可以實(shí)現(xiàn)這個(gè)功能。相對前面的方式，使用起來更加簡單，也可以修改配置輸出中文。 更多精彩博文，歡迎訪問我的個(gè)人博客 說明 我個(gè)人是一直使用Swagger作為接口文檔的說明的。但是由于在一些情況下，接口文檔說明需要以文件的形式交付出去，如果再重新寫一份文檔難免有些麻煩。于是在網(wǎng)上看到了Swagger2Mar...
摘要：其標(biāo)準(zhǔn)為前身是，提供強(qiáng)大的在線編輯功能，包括語法高亮錯(cuò)誤提示自動(dòng)完成實(shí)時(shí)預(yù)覽，并且支持用戶以格式撰寫導(dǎo)入導(dǎo)出轉(zhuǎn)換文檔。 團(tuán)隊(duì)內(nèi)部RestAPI開發(fā)采用設(shè)計(jì)驅(qū)動(dòng)開發(fā)的模式，即使用API設(shè)計(jì)文檔解耦前端和后端的開發(fā)過程，雙方只在聯(lián)調(diào)與測試時(shí)耦合。在實(shí)際開發(fā)和與前端合作的過程中，受限于眾多因素的影響，開發(fā)效率還有進(jìn)一步提高的空間。本文的目的是優(yōu)化工具鏈支持，減少一部分重復(fù)和枯燥的勞動(dòng)。 現(xiàn)狀...
摘要：使用生成，我們可以得到交互式文檔，自動(dòng)生成代碼的以及的發(fā)現(xiàn)特性等。方法指定掃描的包會生成文檔默認(rèn)是顯示所有接口可以用注解標(biāo)識該接口不顯示。 程序員都很希望別人能寫技術(shù)文檔，自己卻很不愿意寫文檔。因?yàn)榻涌跀?shù)量繁多,并且充滿業(yè)務(wù)細(xì)節(jié),寫文檔需要花大量的時(shí)間去處理格式排版,代碼修改后還需要同步修改文檔,經(jīng)常因?yàn)轫?xiàng)目時(shí)間緊等原因?qū)е挛臋n滯后于代碼，接口調(diào)用方的抱怨聲不絕于耳。而程序員是最擅長偷...
摘要：前后端分離后，維護(hù)接口文檔基本上是必不可少的工作。一個(gè)理想的狀態(tài)是設(shè)計(jì)好后，接口文檔發(fā)給前端和后端，大伙按照既定的規(guī)則各自開發(fā)，開發(fā)好了對接上了就可以上線了。本文主要和大伙來聊下在中如何整合。如此，就算配置成功了，非常方便。 前后端分離后，維護(hù)接口文檔基本上是必不可少的工作。一個(gè)理想的狀態(tài)是設(shè)計(jì)好后，接口文檔發(fā)給前端和后端，大伙按照既定的規(guī)則各自開發(fā)，開發(fā)好了對接上了就可以上線了。當(dāng)然...
摘要：集成生成接口文檔原文簡介由于的特性，用來開發(fā)變得非常容易，并且結(jié)合來自動(dòng)生成文檔變得方便快捷。使用生成，我們可以得到交互式文檔。聽過與的結(jié)合，生成更加完備的文檔。接下來將基于與搭建完整的文檔系統(tǒng)。 Spring Boot Swagger2 集成REST ful API 生成接口文檔 原文 簡介 由于Spring Boot 的特性，用來開發(fā) REST ful 變得非常容易，并且結(jié)合 Sw...
閱讀 723·2021-10-09 09:41
閱讀 715·2019-08-30 15:53
閱讀 1143·2019-08-30 15:53
閱讀 1272·2019-08-30 11:01
閱讀 1637·2019-08-29 17:31
閱讀 1063·2019-08-29 14:05
閱讀 1787·2019-08-29 12:49
閱讀 470·2019-08-28 18:17
