Swagger2構(gòu)建Java項(xiàng)目api文檔的正確用法

基礎(chǔ)的用法

怎么接入熄浓,怎么配置情臭,網(wǎng)上的教程一大堆,我也就不贅述了赌蔑,本文主要探討一下其他的進(jìn)階用法俯在,怎么直接用寫的注釋(注意不是注解)來構(gòu)建文檔,這在為老項(xiàng)目生成文檔時(shí)很有用娃惯。

我都寫了注釋了跷乐,為什么還要寫文檔

要解決這個(gè)問題,一般只用在接口和實(shí)體上加上swagger提供的注解就行了石景,這也是基本用法里說過的劈猿,我也就不詳細(xì)說了拙吉,因?yàn)槲乙膊挥眠@種方式。

我都寫了注釋了揪荣,為什么還要寫注解

我的看法swagger提供一套文檔注解并不是最優(yōu)的解法筷黔,因?yàn)檫@會(huì)讓老項(xiàng)目遷移很吃力,要加很多注解仗颈。
作為一個(gè)懶人佛舱,通過調(diào)試跟蹤,發(fā)現(xiàn)他是在ModelMapper.mapModels實(shí)現(xiàn)對(duì)Model對(duì)象的獲取的挨决,我們只要重寫這個(gè)方法即可實(shí)現(xiàn)请祖。ModelMapperImpl類是他的默認(rèn)實(shí)現(xiàn),什么也沒有做脖祈,我們不妨繼承他來重寫哪個(gè)方法肆捕。

如何獲取注釋

可以直接寫一套解析java文件的代碼,也可以直接用現(xiàn)成的包盖高,比如這個(gè)jboss的包慎陵,一般java服務(wù)器相關(guān)的包都有類似的方法。

        <dependency>
            <groupId>org.jboss.forge.roaster</groupId>
            <artifactId>roaster-api</artifactId>
            <version>2.21.1.Final</version>
        </dependency>
        <dependency>
            <groupId>org.jboss.forge.roaster</groupId>
            <artifactId>roaster-jdt</artifactId>
            <version>2.21.1.Final</version>
        </dependency>

部署在服務(wù)器上沒有源代碼怎么解

能獲取到j(luò)ava文件一般也是在本地測(cè)試才有喻奥,部署在服務(wù)器上都是編譯后的class文件席纽,沒有注釋,也不可能將源代碼直接放到部署的機(jī)器上撞蚕,我推薦直接在本地獲取的時(shí)候序列化需要的數(shù)據(jù)到文件润梯,直接丟在服務(wù)器上即可。

代碼呢甥厦?代碼呢纺铭?代碼呢?

  • 筆者已經(jīng)貼心的將項(xiàng)目做成的starter刀疙,歡迎fork彤蔽,大家積極提PR,一起完善庙洼!

GITEE上源碼鏈接

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末顿痪,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子油够,更是在濱河造成了極大的恐慌蚁袭,老刑警劉巖,帶你破解...
    沈念sama閱讀 217,185評(píng)論 6 503
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件石咬,死亡現(xiàn)場(chǎng)離奇詭異揩悄,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)鬼悠,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,652評(píng)論 3 393
  • 文/潘曉璐 我一進(jìn)店門删性,熙熙樓的掌柜王于貴愁眉苦臉地迎上來亏娜,“玉大人,你說我怎么就攤上這事蹬挺∥兀” “怎么了?”我有些...
    開封第一講書人閱讀 163,524評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵巴帮,是天一觀的道長(zhǎng)溯泣。 經(jīng)常有香客問我,道長(zhǎng)榕茧,這世上最難降的妖魔是什么垃沦? 我笑而不...
    開封第一講書人閱讀 58,339評(píng)論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮用押,結(jié)果婚禮上肢簿,老公的妹妹穿的比我還像新娘。我一直安慰自己蜻拨,他們只是感情好译仗,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,387評(píng)論 6 391
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著官觅,像睡著了一般。 火紅的嫁衣襯著肌膚如雪阐污。 梳的紋絲不亂的頭發(fā)上休涤,一...
    開封第一講書人閱讀 51,287評(píng)論 1 301
  • 那天,我揣著相機(jī)與錄音笛辟,去河邊找鬼功氨。 笑死,一個(gè)胖子當(dāng)著我的面吹牛手幢,可吹牛的內(nèi)容都是我干的捷凄。 我是一名探鬼主播,決...
    沈念sama閱讀 40,130評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼围来,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼跺涤!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起监透,我...
    開封第一講書人閱讀 38,985評(píng)論 0 275
  • 序言:老撾萬榮一對(duì)情侶失蹤桶错,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后胀蛮,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體院刁,經(jīng)...
    沈念sama閱讀 45,420評(píng)論 1 313
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,617評(píng)論 3 334
  • 正文 我和宋清朗相戀三年粪狼,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了退腥。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片任岸。...
    茶點(diǎn)故事閱讀 39,779評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖狡刘,靈堂內(nèi)的尸體忽然破棺而出享潜,到底是詐尸還是另有隱情,我是刑警寧澤颓帝,帶...
    沈念sama閱讀 35,477評(píng)論 5 345
  • 正文 年R本政府宣布米碰,位于F島的核電站,受9級(jí)特大地震影響购城,放射性物質(zhì)發(fā)生泄漏吕座。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,088評(píng)論 3 328
  • 文/蒙蒙 一瘪板、第九天 我趴在偏房一處隱蔽的房頂上張望吴趴。 院中可真熱鬧,春花似錦侮攀、人聲如沸锣枝。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,716評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽撇叁。三九已至,卻和暖如春畦贸,著一層夾襖步出監(jiān)牢的瞬間陨闹,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,857評(píng)論 1 269
  • 我被黑心中介騙來泰國(guó)打工薄坏, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留趋厉,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 47,876評(píng)論 2 370
  • 正文 我出身青樓胶坠,卻偏偏與公主長(zhǎng)得像君账,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子沈善,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,700評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容