이 기사는 Spring Boot 프로젝트에서 Swagger2를 사용하는 예를 소개합니다. 그것은 당신과 공유됩니다. 세부 사항은 다음과 같습니다.
Swagger2 종속성을 추가하십시오
pom.xml에 swagger2 종속성을 추가하십시오
<pectionency> <groupid> io.springfox </groupid> <artifactid> springfox-swagger2 </artifactid> <버전> 2.2.2 </version> </dependency> <prectionement> <groupid> io.springfox </groupid> <artifactid> springfox-swagger-ui </artifactid>
Swagger2 구성 클래스를 만듭니다
Application.java 동시 레벨에서 Swagger2의 구성 클래스 Swagger2를 만듭니다.
import org.springframework.context.annotation.bean; import org.springframework.context.annotation.configuration; import springfox.documentation.builders.builders.apiinfobuilder; import springfox.documentation.builders.pathselectors; import springfox.documentator; recumentators; recumentator springfox.documentation.service.apiinfo; import springfox.documentation.spi.documentationtype; import springfox.documentation.spring.web.plugins.docket; import springfox.documentation.swagger2.annotations.enableswagger2;@configuring@configger2ppppppppoggger2pppppoggger createrestapi () {return new Docket (hoc } private apiinfo apiinfo () {return new apiinfobuilder () .title ( "neo4j restful apis") .description ( "neo4j restful apis description/") .TermsOfServiceUrl ( "") .Contact ( "li Qinghai"). }}문서 내용을 추가하십시오
위의 구성을 완료 한 후 문서 내용을 실제로 작성할 수 있지만 이러한 문서는 주로 요청 자체를 목표로하며 설명은 주로 사용자 친화적이지 않은 기능 및 기타 기능의 이름에서 비롯됩니다. 우리는 일반적으로 문서 내용을 풍부하게하기 위해 몇 가지 지침을 추가해야합니다.
import io.swagger.annotations.api; import io.swagger.annotations.apioperation; import io.swagger.annotations.apiparam;/** * 시스템 사용자 컨트롤러 * * @author li qinghai */@api (value = "System User Interface", tags = "system management"@restController ( "/v3/user") usercontroller {@autowired private userervice userervice; /** * register * * @param loginname * 계정에 로그인 * @param username * @param password * 로그인 암호 * @param reaconId * user roin * @Throws ResourceExistSexception */@apioperation (value = "/") @postmapping ( "/") 공개 jsonresult 만들기 (@apiparam (@apiparam). "login ac 문자열 비밀번호, @apiparam (이름 = "roleID", value = "사용자 역할 번호", 필수 = true) @requestparam (requestparam (requestparam) @requestbody string roleceid) {boolean ensists = this.userservice.exists (loginname); if (ensists) {새로운 ResourceExistSexception (loginname); } user user = userervice.create (loginName, password, username, reaconId); 새로운 jsonresult (사용자)를 반환합니다. }}API를 봅니다
Spring Boot 프로그램을 시작하고 방문 : http : // localhost : 8080/swagger-ui.html
API 문서 액세스 및 디버깅
Swagger는 인터페이스 기능을 보는 것 외에도 디버깅 및 테스트 기능을 제공합니다. 위 그림의 오른쪽에있는 모델 스키마 (노란색 영역 : 데이터 구조를 나타냄)를 클릭 할 수 있습니다. 현재 값의 사용자 객체에 대한 템플릿이 있습니다. 약간만 수정하면됩니다. 아래에서 시도해보십시오! 버튼, 요청 통화를 완료 할 수 있습니다! 이전 게시물 요청이 올바른지 확인하기 위해 여러 개의 GET 요청을 사용할 수 있습니다.
위는이 기사의 모든 내용입니다. 모든 사람의 학습에 도움이되기를 바랍니다. 모든 사람이 wulin.com을 더 지원하기를 바랍니다.