1 종속성 추가 : 첫 번째의 pom.xml에 Swagger2 의존성을 추가하는 방법 :
<! - 자신감依赖-> < 의존성 > < 의 groupId > io.springfox </ 의 groupId > < artifactId를 > springfox-swagger2 </ artifactId를 > < 버전 > 2.6.1 </ 버전 > </ 의존성 > <! - 用于生成在线文档的-> < 의존성 > < 의 groupId > io.springfox </ 의 groupId > < artifactId를 >springfox-자신감 UI- </artifactId를 > < 버전 > 2.6.1 </ 버전 > </ 의존성 >
2 컨트롤러 클래스의 설명 :
(1), 데이터를 저장하기위한 단순한 엔티티 클래스를 만들려면
공공 클래스 예약 { // 属性 개인 정수 입찰; 개인 문자열 BNAME; 개인 문자열 bprotagonist; 개인 문자열 BTYPE; 공공 도서 () { 슈퍼 (); } 공공 도서 (정수 입찰, 문자열 BNAME, 문자열 bprotagonist, 문자열 BTYPE) { 슈퍼 (); 이 .BID =이 입찰; 이 .bname = BNAME; 이 .bprotagonist = bprotagonist; 이 .btype = BTYPE; } 공공 정수 getBid () { 반환 입찰; } 공공 무효 setBid (정수 입찰) { 이 .BID = 입찰; } 공공 문자열 getBname () { 반환 BNAME; } 공공 공극 setBname (문자열 BNAME) { 이 .bname = BNAME; } 공공 문자열 getBprotagonist () { 반환 bprotagonist; } 공공 무효 setBprotagonist (문자열 bprotagonist) { 이 .bprotagonist = bprotagonist; } 공공 문자열 getBtype () { 반환 BTYPE; } 공공 공극 setBtype (문자열 BTYPE) { 이 .btype = BTYPE; } @Override 공공 문자열 toString () { 반환 "도서 [입찰 ="+ 입찰 + ", BNAME ="+ BNAME + ", bprotagonist ="+ bprotagonist + ", BTYPE ="+ BTYPE + "]" ; } }
(2)의 효과를 나타내는 시뮬레이션 된 데이터에 간단한 제어를 만들 :
반환 책을; } / ** *添加 * @param의 책 * @return * / @GetMapping ( "/ 추가" ) 공공 도서 addBook (도서 책) { 반환 책; } }
3 제조 Swagger2 구성 클래스 주사 제어부 SpringMVC :
CTRL + SHITF + O를 {} 추천 클래스의 구성 코드의 대부분은 고정되어 있지만, 컨트롤러가 잘못된 패키지 이름이 될 수 없습니다가, 복사 바로 가기 자동으로 필요한 패키지를 소개합니다 :
/ ** * Swagger2 구성 클래스 * / @Configuration // 구성 클래스로 표시 EnableSwagger2 @ // Swagger2 앱은 또한 부트 클래스에 기록 활성화를위한 공공의 클래스 Swagger2Config { @Bean 공공 문서 번호 createRestApi () { // 스캔 컨트롤러 Swagger2 노트에, 내부 .apis이 지정된 패키지를 나타냅니다 반환 새로운 새로운 꼬리표 (DocumentationType.SWAGGER_2) .apiInfo (apiInfo ()) ALL 기타 사항 서보 -OFF () // 컨트롤러의 패키지 이름 .apis (RequestHandlerSelectors.basePackage ( "com.szc을 .controller " )) .paths (PathSelectors.any ()) .build (); } // API 설명 개인 ApiInfo apiInfo () { 반환 새로운 새로운 ApiInfoBuilder () .title ( "SprignBoot 통합 sawgger2 온라인 API 문서") // 제목 .description ( "정보 문서를 설명") // 설명 .termsOfServiceUrl ( "https://baidu.com") // URL .version ( "szc_1.0") // 버전 .build (); } }
4, 응용 프로그램 시작 클래스 SpringBoot 프로젝트를 시작합니다
5, 성공적인 출시 후, 브라우저의 주소 표시 줄에 입력 HTTP : // localhost를 : 8080 / 자신감-ui.html , 당신은 볼 수 있습니다
컨트롤러 이름을 열기, 당신이 볼 수있는 식으로
층 법에 의해 층을 개방형, 방법은 또한 원하는 파라미터 또는 리턴 데이터를 볼 수있다