스프링 부팅에서 Swagger-Bootstrap-UI를 사용하는 방법

Swagger-Bootstrap-UI는 Swagger Interface API를 기반으로 구현 된 UI입니다. Swagger Native UI는 상단 및 하부 구조를 가지므로 인터페이스를 탐색 할 때 명확하지 않습니다. 따라서 Swagger-Bootstrap-UI는 왼쪽 및 오른쪽 메뉴 스타일을 기반으로하며 개발 백엔드 시스템의 왼쪽 및 오른쪽 구조 스타일과 유사하므로 인터페이스로 브라우징에 편리합니다.

github : https://github.com/xiaoymin/swagger-bootstrap-ui

인터페이스 미리보기 :

Swagger를 소개합니다

pom.xml 파일에 Swagger 및 UI의 JAR 패키지 종속성을 소개합니다.

 <pectionency> <groupid> io.springfox </groupid> <artifactid> springfox-swagger2 </artifactid> <버전> 2.7.0 </version> </dependency> <!-소개 UI 패키지-> <pelection> <groupid> com.github.xiaoymin </groupId> <artifactid> <버전> 1.7 </버전> </의존성>

구성 구성

swagger의 구성 파일 사용 파일, key annotation @enablebsger2 구성

다음 구성은 인터페이스 그룹화를 지원하는 구성입니다. 그룹화 구성이없는 경우 도켓 만 만들면됩니다.

 @configuration @enableswagger2public class swaggerconfiguration {@bean public docket createrestapi () {return new Docket (documentationType.wagger_2) .apiinfo (apiinfo ()) .groupName ( "resource management") .select (). .apis (requestHandlersElectors.basePackage ( "com.lishiots.dc.baseinfo.ctl")) .paths (pathselectors.any ()) .build (); } @bean public docket createmoniterrestapi () {return new docket (documentationtype.swagger_2) .apiinfo (apiinfo ()) .groupname ( "실시간 모니터링") .select () .apis (requesthandlerselectors.basepackage ( "com.lishiots.dc.monitor.ctl"). .paths (pathselectors.any ()) .build (); } @bean public docket createAcTivitirestapi () {return new docket (documentationType.wagger_2) .apiinfo (apiinfo ()) .groupname ( "Workflow Engine") .apis (requestHandlersElectors.basePackage ( "com.lishiots.ctiviti.ctl")). .paths (pathselectors.any ()) .build (); } @bean public docket createbaserestapi () {return new docket (hodectiontype.swagger_2) .apiinfo (apiinfo ()) .groupname ( "kernel module") .apis (requesthandlerselectors.basepackage ( "com.lishiots.ctl"). .paths (pathselectors.any ()) .build (); } @bean public docket createcomempraintrestapi () {return new docket (documentationtype.swagger_2) .apiinfo (apiinfo ()) .groupname ( "Complaint Management") .select () .apis (requestHandlersElectors.basePackage ( "com.lishiots.dc.complaint"). .paths (pathselectors.any ()) .build (); } private apiinfo apiinfo () {새로운 apiinfobuilder () .title ( "swagger restful apis") .description ( "swagger restful apis") .termsofserviceurl ( "http://www.test.com/") .짓다(); }}

컨트롤러 레이어는 Swagger 주석을 사용합니다

CTL 코드 계층 :

 @api (tags = "배너 관리")@restController@requestMapping ( "/api/bannerInfo") 공개 클래스 배너 CTL {@autowired private bannerInfoservice Service; @postmapping ( "/query") @apioperation (value = "query banner", notes = "Query Banner") public Pagination <BannerInfo> bannerInfoQuery () {Pagination <BannerInfo> Pagination = service.bannerInfoQuery (); 반환 페이지 매김; }}

인터페이스 액세스

브라우저를 입력하십시오 : http : // $ {host} : $ {port} /doc.html

요약

위의 것은 스프링 부츠에서 Swagger-Bootstrap-UI를 사용하는 방법입니다. 나는 그것이 당신에게 도움이되기를 바랍니다. 궁금한 점이 있으면 메시지를 남겨 주시면 편집자가 제 시간에 답장을 드리겠습니다. Wulin.com 웹 사이트를 지원해 주셔서 대단히 감사합니다!