?前言
knife4j的前身是swagger-bootstrap-ui，是在github上開源的第三方swagger界面美化工具敏释，目的是為了替代springfox-swagger-ui
導(dǎo)入依賴
配置文件
knife4j訪問(wèn)地址:? ?http://localhost:8081/doc.html#/home
swagger注解詳解
@Api：用在請(qǐng)求的類上库快，表示對(duì)類的說(shuō)明
? ? tags="說(shuō)明該類的作用，可以在UI界面上看到的注解"
? ? value="該參數(shù)沒(méi)什么意義钥顽，在UI界面上也看到义屏，所以不需要配置"
@ApiOperation：用在請(qǐng)求的方法上，說(shuō)明方法的用途蜂大、作用
? ? value="說(shuō)明方法的用途闽铐、作用"
? ? notes="方法的備注說(shuō)明"
@ApiImplicitParams：用在請(qǐng)求的方法上，表示一組參數(shù)說(shuō)明
? ? @ApiImplicitParam：用在@ApiImplicitParams注解中奶浦，指定一個(gè)請(qǐng)求參數(shù)的各個(gè)方面
? ? ? ? name：參數(shù)名
? ? ? ? value：參數(shù)的漢字說(shuō)明兄墅、解釋
? ? ? ? required：參數(shù)是否必須傳
? ? ? ? paramType：參數(shù)放在哪個(gè)地方
? ? ? ? ? ? · header --> 請(qǐng)求參數(shù)的獲取：@RequestHeader
? ? ? ? ? ? · query --> 請(qǐng)求參數(shù)的獲劝牟妗：@RequestParam
? ? ? ? ? ? · path（用于restful接口）--> 請(qǐng)求參數(shù)的獲认断獭：@PathVariable
? ? ? ? ? ? · div（不常用）
? ? ? ? ? ? · form（不常用）? ?
? ? ? ? dataType：參數(shù)類型，默認(rèn)String成洗，其它值dataType="Integer"? ? ?
? ? ? ? defaultValue：參數(shù)的默認(rèn)值
@ApiResponses：用在請(qǐng)求的方法上五督，表示一組響應(yīng)
? ? @ApiResponse：用在@ApiResponses中，一般用于表達(dá)一個(gè)錯(cuò)誤的響應(yīng)信息
? ? ? ? code：數(shù)字瓶殃，例如400
? ? ? ? message：信息充包，例如"請(qǐng)求參數(shù)沒(méi)填好"
? ? ? ? response：拋出異常的類
@ApiModel：用于響應(yīng)類上，表示一個(gè)返回響應(yīng)數(shù)據(jù)的信息
? ? ? ? ? ? （這種一般用在post創(chuàng)建的時(shí)候遥椿，使用@RequestBody這樣的場(chǎng)景基矮，
? ? ? ? ? ? 請(qǐng)求參數(shù)無(wú)法使用@ApiImplicitParam注解進(jìn)行描述的時(shí)候）
????@ApiModelProperty：用在屬性上，描述響應(yīng)類的屬性
測(cè)試
