基礎(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,一起完善庙洼!