澶у濂斤紝鎴戜滑鍙堣闈簡銆傚湪涔嬪墠鐨勬枃妗ｃ€奐AVA涓嚜瀹氫箟鎵╁睍Swagger鐨勮兘鍔涳紝鑷姩鐢熸垚鍙傛暟鍙栧€煎惈涔夎鏄庯紝鎻愬崌寮€鍙戞晥鐜囥€嬩腑锛屾垜浠璁轰簡濡備綍閫氳繃鑷畾涔夋敞瑙ｆ潵鎵╁睍swagger鐨勮兘鍔涳紝浣垮緱Swagger鏀寔浠庢寚瀹氱殑鏋氫妇绫昏嚜鍔ㄧ敓鎴愭帴鍙ｆ枃妗ｄ腑鐨勫瓧娈垫弿杩扮殑瀹炵幇鎬濊矾銆傚叾瀹瀞wagger浣滀负涓€涓簲鐢ㄥ箍娉涚殑鍦ㄧ嚎鎺ュ彛鏂囨。杈呭姪宸ュ叿锛岃櫧鐒剁畝鍗曟槗鐢紝浣嗚鐢ㄥソ杩樻槸闇€瑕佷笅鍔熷か鐨勩€傞偅涔堬紝杩欑瘒鏂囨。灏卞拰澶у鑱婅亰濡備綍鐢ㄥソswagger锛岃瀹冪湡姝ｆ垚涓烘垜浠」鐩氦浠樿繃绋嬩腑鐨勬硶瀹濄€傛洿鏀规帴鍙ｆ枃妗ｇ殑閫氱敤鏍囬鍜屾弿杩伴粯璁ゆ儏鍐典笅锛孲wagger鎺ュ彛鏁翠釜鏂囨。鐨勫悕绉板拰鎻忚堪閮芥槸閫氱敤鍊硷紝杩欐牱浼氳浜烘嬁鍒版枃妗ｅ悗涓€澶撮浘姘达紝鍒嗕笉娓呮槸鍝釜椤圭洰锛屽摢涓郴缁熶互鍙婂摢涓湇鍔＄粰瀹冩彁渚涗簡鎺ュ彛锛屼笉鐭ラ亾鏄摢涓洟闃熻礋璐ｆ帴鍙ｏ紝鍝釜寮€鍙戣€呯淮鎶ょ殑銆備緥濡傚涓嬶細涓轰簡浣撶幇鎺ュ彛鏂囨。鐨勪笓涓氭€э紝鏂逛究澶у浜嗚В鎺ュ彛鏂囨。鐨勭郴缁熴€佸搴旂増鏈€佺淮鎶ゅ洟闃熺瓑淇℃伅锛屾垜浠彲浠ユ牴鎹渶瑕佸湪浠ｇ爜涓嚜瀹氫箟鐩稿叧鍐呭.渚嬪锛欯BeanpublicDocketcreateRestApi(){ApiInfoapiInfo=newApiInfoBuilder().title("璧勬簮绠＄悊绯荤粺鎺ュ彛鏂囨。").description("APP/WEB璋冪敤璧勬簮绠＄悊妯″潡鎺ュ彛鐨勮缁嗘枃妗ｈ鏄?).version("v1.0.0").contact(newContact("鏋舵瀯鍚挋","https://juejin.cn/user/1028798616709294","veezean@outlook.com")).termsOfServiceUrl("https://juejin.cn/user/1028798616709294").license("ApacheLicense").licenseUrl("http://xxx").build();杩斿洖鏂扮殑Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo).select()銆俠uild();}閲嶅惎鏌ョ湅鐣岄潰锛屽彲浠ュ彂鐜扮晫闈笂鐨勭浉鍏冲唴瀹瑰凡缁忔敼鎴愪簡鎴戜滑鑷畾涔夌殑鍐呭锛屾槸涓嶆槸姣旀敼涔嬪墠鏇村姞娓呮櫚涓撲笟浜嗭紵涓婅堪swagger鏀寔鑷畾涔夋弿杩板瓧娈典俊鎭紝褰掔撼濡備笅锛氬瓧娈靛惈涔夋弿杩版爣棰樻帴鍙ｆ枃妗ｆ枃妗ｆ爣棰樻弿杩版帴鍙ｆ枃妗ｈ缁嗘暣浣撴弿杩扮増鏈帴鍙ｆ枃妗ermsOfServiceUrl瀵瑰簲鐨勭増鏈俊鎭鎺ュ彛鐨勬彁渚涘洟闃熷搴旂殑鍥㈤槦documenturl鍦板潃contact璐熻矗杩欓儴鍒嗘帴鍙ｇ殑鑱旂郴淇℃伅锛屽寘鎷鍚嶃€侀偖绠便€佷富椤祏rl鍦板潃绛夈€俵icense鎸囧畾鎺ュ彛閬靛惊鐨刲icense鍗忚鐗堟湰銆俵icenseUrl璇ユ帴鍙ｉ伒寰殑璁稿彲鍗忚鐨勮缁嗕粙缁嶃€傜晫闈㈠唴瀹瑰湪鎵嬪姩缂栧啓鐣岄潰鏂囨。鏃讹紝鎴戜滑鍙互鏍规嵁瀹為檯鎯呭喌鐏垫椿鎺у埗闇€瑕佸啓鍏ユ枃妗ｇ殑鐣岄潰鍐呭鍜岀晫闈㈠唴瀹广€傜鍙ｇ殑request-responsebody涓殑瀛楁淇℃伅鈥斺€斿洜涓哄苟涓嶆槸绯荤粺涓彁渚涚殑鎵€鏈夋帴鍙ｉ兘闇€瑕佸湪鎺ュ彛鏂囨。涓綋鐜板嚭鏉ユ毚闇茬粰璋冪敤鏂圭煡閬擄紝姣斿鏈変竴浜涚郴缁熺姸鎬佺洃鎺ф帴鍙ｅ彧闇€瑕佸唴閮ㄤ娇鐢ㄤ篃灏辨槸璇达紝瀵逛簬Swagger鏉ヨ锛屽湪鐢熸垚鎺ュ彛鏂囨。鏃讹紝榛樿鏄壂鎻忔墍鏈堾Controllers涓殑鎵€鏈夋帴鍙ｆ柟娉曪紝骞舵樉绀哄湪鏂囨。涓紝浣嗕篃鑰冭檻浜嗘寜闇€闅愯棌鎴栨樉绀烘帴鍙ｅ湪瀹為檯搴旂敤涓€傚唴瀹瑰惛寮曚汉骞舵彁渚涘绉嶄笉鍚岀殑鏂瑰紡鏉ユ敮鎸佸畠銆備笅闈㈡垜浠竴璧锋潵鐪嬬湅鍚с€備负鍗曚釜鎺ュ彛闅愯棌鍦ㄥ崟涓帴鍙ｆ柟娉曚笂闈㈡坊鍔燖ApiOperation娉ㄨВ锛屾寚瀹歨idden=true瀵箂wagger鎺ュ彛闅愯棌鎺ュ彛锛欯GetMapping("/test")@ApiOperation(value="internaltestInterface",hidden=true)publicStringtest(){return"OK";}鍚姩娴佺▼锛屾煡鐪婼wagger鎺ュ彛锛屽彂鐜版帴鍙ｄ笂娌℃湁鍑虹幇鎺ュ彛锛氬鏋滄暣涓狢ontroller涓嬬殑鎵€鏈夋帴鍙ｉ兘闅愯棌鎺ュ彛鍦ㄦ暣涓狢ontroller绫讳腑class閮介渶瑕侀殣钘忥紝鍙互鍦–onntroller绫讳腑鍔犱笂@ApiIgnore娉ㄨВ銆侤RestController@RequestMapping("/test")@ApiIgnorepublicclassTestController{//...ignore...}淇敼鍚庨噸鍚繘绋嬶紝鐒跺悗鎵撳紑swagger鐣岄潰锛屽彂鐜版暣涓猅estController绫荤殑鐣岄潰涓嶆樉绀恒€傝繖閲岃ˉ鍏呬竴涓嬶紝鍥犱负鐢ㄦ潵鎻忚堪Controller绫绘帴鍙ｅ惈涔夌殑娉ㄨВ@Api涔熸湁涓€涓猦idden灞炴€э紝鐪嬬湅瀹冪殑婧愮爜娉ㄨВ锛屽鏋滆缃甴idden=true锛屽簲璇ヤ篃浼氭妸Controller绫婚殣钘忎负涓€涓墍鏈夌殑銆備絾瀹為檯涓婏紝娴嬭瘯鍙戠幇骞舵病鏈夌敓鏁堛€備娇鐢ㄨ繖涓灏忓績锛堝熀浜巗wagger2.7.0鐗堟湰娴嬭瘯锛屼笉纭畾鏄笉鏄疊UG锛夈€侤Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)@Inheritedpublic@interfaceApi{/***闅愯棌璇ヨ祫婧愪笅鐨勬搷浣溿€?*@returntrueiftheapishouldbehiddenfromtheswaggerdocumentation*/booleanhidden()defaultfalse;}鍙樉绀烘寚瀹氬寘璺緞涓嬬殑鎺ュ彛銆傛垜浠殑椤圭洰涓粡甯镐細渚濊禆鎴栬€呭紩鐢ㄤ竴浜涚涓夋柟鐨刯ar鍖咃紝鏈夋椂鍊欒繖浜涚涓夋柟鐨刯ar鍖呬篃浼氭彁渚涗竴浜涙帴鍙ｏ紝杩欎簺鎺ュ彛涔熶細鍑虹幇鍦ㄦ垜浠殑鎺ュ彛鏂囨。涓€傝繖鏍蜂竴鏉ワ紝灏变細鏄惧緱鎺ュ彛鏂囨。涓湁寰堝涓嶇‘瀹氱殑鍐呭銆備緥濡傦細鍥犱负涓氬姟浠ｇ爜涓病鏈夋彁渚涜繖閮ㄥ垎閫昏緫锛屾墍浠ユ垜浠棤娉曢€氳繃淇敼婧愮爜锛岄€氳繃涓婅堪鏂瑰紡娣诲姞hidden=true鏉ユ帶鍒跺叾涓嶆樉绀恒€傝繖鏃跺€欏氨闇€瑕佸叿澶囨牴鎹寘杩涜鐧藉悕鍗曟帶鍒剁殑鑳藉姏銆係wagger涔熸敮鎸佸熀浜庣粰瀹氱殑basePackage鍜岃矾寰勭殑缁勫悎鎺у埗锛屽彧鏄剧ず缁欏畾鍖呬笅鎸囧畾璺緞涓嬬殑鎺ュ彛銆侤BeanpublicDocketcreateRestApi(){ApiInfoapiInfo=newApiInfoBuilder().title("璧勬簮绠＄悊绯荤粺鎺ュ彛鏂囨。").description("APP/WEB璋冪敤璧勬簮绠＄悊妯″潡鎺ュ彛鐨勮缁嗘枃妗ｈ鏄?).version("v1.0.0").build();ApiSelectorBuilderselectorBuilder=(newDocket(DocumentationType.SWAGGER_2)).apiInfo(apiInfo).select();selectorBuilder.apis(RequestHandlerSelectors.basePackage("com.jiagouwudao.resmanage"));selectorBuilder.paths(PathSelectors.any());returnselectorBuilder.build();}杩欐牱鍙互淇濊瘉鎺ュ彛鏂囨。涓嚭鐜扮殑鎵€鏈夋帴鍙ｉ兘鏄垜浠嚜宸卞畾涔夌殑鎺ュ彛銆傞噸鍚苟鍒锋柊鐣岄潰锛屼綘浼氬彂鐜皊wagger鐣岄潰涓婂彧鏄剧ず浜嗘寚瀹氬寘鐩綍涓嬬殑Controller鐣岄潰銆傞殣钘忓搷搴斾腑涓嶆効鏆撮湶鐨勫睘鎬у湪椤圭洰寮€鍙戣繃绋嬩腑锛屽鏋滄垜浠殑浠ｇ爜娌℃湁寮哄埗鎬х殑VO鍜孌O鍒嗗尯锛屼负浜嗗噺灏戠紪鐮侀噺锛屾垜浠彲鑳戒細浣跨敤鍚屼竴涓璞¤繘琛屽唴閮ㄥ鐞嗗拰澶栭儴浜や簰.渚嬪锛氬畾涔変竴涓狾perateLog瀵硅薄锛屽畠鏄暟鎹簱涓璗_OPERATE_LOG琛ㄥ搴旂殑瀹炰綋绫伙紝鐢ㄤ簬璁板綍姣忎釜鐢ㄦ埛鐨勬搷浣滆涓猴紱鍚屾椂浣滀负recordOperateLog鎺ュ彛鐨勮姹備綋锛屼紶閫掗渶瑕佽褰曠殑鐢ㄦ埛鎿嶄綔淇℃伅銆備笂渚嬩腑锛氫綔涓烘暟鎹〃瀹炰綋绫昏繘琛岄€昏緫澶勭悊鏃讹紝闇€瑕佷娇鐢ㄥ敮涓€涓婚敭id淇℃伅浣滀负recordOperateLog鎺ュ彛鐨勮姹備綋鏃讹紝璋冪敤鑰呬笉闇€瑕佹寚瀹氳繖鏉¤褰曠殑id鍊硷紙ID鍊间細鍦―B涓瓨鍌ㄦ椂锛孌B浼氳嚜鍔ㄧ敓鎴愪竴涓敮涓€鐨勮嚜澧炰富閿級鍦ㄨ繖绉嶅満鏅笅锛屾垜浠笇鏈涘湪鎻愪緵鐨勬帴鍙ｆ枃妗ｄ腑锛宨d瀛楁涓嶅簲璇ヤ綋鐜板湪瀛楁鎻忚堪涓璻ecordOperateLog鎺ュ彛鐨剅equestbody锛岄伩鍏嶈皟鐢ㄨ€呮贩娣嗭紝涓嶇煡閬撹皟鐢ㄦ椂id搴旇濡備綍鍒嗛厤銆傛垜浠彲浠ラ€氳繃鍦ㄦ寚瀹氬瓧娈典笂娣诲姞@ApiModelProperty娉ㄨВ骞舵寚瀹歨idden=true灏嗗叾闅愯棌鍦ㄦ帴鍙ｆ枃妗ｄ腑銆備緥濡傦細@Data@ApiModel("鎿嶄綔璁板綍淇℃伅")publicclassOperateLog{@ApiModelProperty(value="璁板綍鍞竴ID锛屾棤鎰忎箟",hidden=true)privatelongid;@ApiModelProperty("鎿嶄綔绫诲瀷锛屽彇鍊艰鏄庯細1銆佹坊鍔狅紱2銆佹洿鏂帮紱3銆佸垹闄わ紱4銆佹煡璇?)privateintoperateType;@ApiModelProperty("鎿嶄綔鐢ㄦ埛")绉佹湁瀛楃涓茬敤鎴凤紱@ApiModelProperty(value="OperationDetails")privateStringdetail;}閭ｄ箞鎺ュ彛涓殑鎺ュ彛鏂囨。鏄笉浼氭樉绀篿d鐨勭浉鍏充俊鎭殑锛堟敞鎰忥細鍙槸鎺ュ彛鏂囨。涓嶅弽鏄狅紝涓嶄細褰卞搷瀹為檯鍊硷級鐗瑰畾璇锋眰鎴栧搷搴斾腑鐨勬瀛楁锛夈€傚叧闂敓浜х幆澧冪殑swagger鑰冭檻鍒扮敓浜х幆澧冪殑瀹夊叏鎬э紝瀵逛簬涓€浜涙瘮杈冮噸瑕佺殑绯荤粺锛屾垜浠竴鑸兘涓嶆効鎰忔毚闇茬敓浜х幆澧冪殑鎺ュ彛鏂囦欢锛屼互鍏嶇粰绯荤粺鐨勮繍琛屽甫鏉ラ殣鎮ｃ€傚湪SpringBoot椤圭洰涓紝鎴戜滑浼氶拡瀵逛笉鍚岀殑鐜鎻愪緵涓嶅悓鐨勯厤缃枃浠讹紝鐒跺悗閫氳繃--spring.active.profile鏉ユ寚瀹氬惎鍔ㄦ椂鍔犺浇鍝簺閰嶇疆銆傚鏋滄垜浠渶瑕佷娇Swagger鍙闂紝鎴戜滑鍙互閫氳繃鍦ㄤ唬鐮佷腑娣诲姞@EnableSwagger2娉ㄨВ鏉ュ疄鐜般€傚鏋滈檺鍒跺湪寮€鍙戞垨娴嬭瘯鐜鍙厑璁竤wagger璁块棶锛岀敓浜х幆澧冧笉鍏佽寮€鍚紝鍙渶瑕佽@EnableSwagger2娉ㄨВ鐨勭被鏍规嵁褰撳墠杩愯鐜鍐冲畾鏄惁鍔犺浇鍗冲彲銆傚€熷姪SpringBoot鎻愪緵鐨凘Profile娉ㄨВ锛屾垜浠彲浠ヨ繖鏍峰疄鐜帮細@Configuration@EnableSwagger2@Profile({"DEV","TEST"})publicclassSwaggerConfig{}杩欐牱锛孲waggerConfig绫诲氨鍙互涓嶅綋profile=PROD鏃朵細琚姞杞斤紝swagger鐨勫紑鍏充笉浼氭墦寮€銆備娇鐢?-spring.active.profile=PROD鍚姩杩涚▼锛屽皾璇曡闂畇wagger鐣岄潰锛屽彂鐜版墦涓嶅紑锛氫负Swagger鎹㈢毊鑲ゃ€傞粯璁ょ殑swagger鐣岄潰鏄剧ず鐨勬槸灞呬腑鍒楀嚭鐨勬墍鏈夊唴瀹癸紝鐒跺悗闇€瑕侀€愬眰灞曞紑銆備笂闈㈢殑鎿嶄綔骞朵笉澶柟渚匡紝鏁翠綋鐨勭晫闈㈤鏍间篃涓嶅お绗﹀悎涓€涓€滄枃妗ｂ€濈殑澶栬銆備负浜嗘彁鍗囩敤鎴蜂綋楠岋紝鍙互浣跨敤寮€婧愮殑knife4j妗嗘灦璁﹕wagger鏇村ソ鐢ㄣ€備娇鐢ㄦ柟娉曢潪甯哥畝鍗曘€傚湪鐜版湁swagger渚濊禆鐨勫熀纭€涓婏紝鍦╬om.xml涓坊鍔犲涓嬪紩鐢ㄤ緷璧栵細
