머리말
이전 블로그에서 우리는 서비스를 Eureka에 등록했습니다. Eureka의 UI 인터페이스에서 서비스가 Eureka Server에 등록 된 서비스를 볼 수 있습니다. 그러나 현재 서비스에서 어떤 RESTFUL 인터페이스 방법을 제공하는지 확인하려면이를 얻을 방법이 없습니다. 기존의 방법은 개발자 간의 통신을위한 서비스 인터페이스 문서를 정렬하는 것입니다. 이 경우 여러 번 문서와 코드 사이에 불일치가 변경되었지만 코드가 변경되는 것과 같은 코드가 변경되지 않았지만 인터페이스 문서는 변경되지 않았으며 Swagger2는 완벽한 솔루션을 제공합니다. Swagger2가 문제를 해결하는 방법을 살펴 보겠습니다.
1. Swagger2가 의존하는 JAR 패키지를 소개하십시오
<!-Swagger2-> <pectionement> <groupId> io.springfox </groupid> <artifactid> springfox-swagger2 </artifactid> <bersion> 2.2.2 </dependency> <prection> <groupid> io.springfox </groupid> <버전> 2.2.2 </버전> </의존성>
2. Swagger2의 구성을 초기화합니다 2
@configuration @enablebsger2 // enable swagger2 public class swagger2 {@bean public docket createrestapi () {// API BASIC INFORMATION 리턴 새 DOCKET (documentationType.wagger_2) .apiinfo (apiinfo ()) .select (). .apis (requestHlersElectors.basePackage ( "com.chhliu.jpa")) // @apiignore annotation annotated.paths (pathelectors.any ()) .build (); } private apiinfo apiinfo () {// API 생성에 대한 기본 정보는 Swagger UI에 표시됩니다. 새로운 APIINFOBUILDER () .TITLE ( "Swagger2를 사용하여 스프링 부츠에 편안한 API를 구축합니다. }}참고 :이 구성 클래스는 응용 프로그램 디렉토리에서 동일한 수준의 생성해야합니다. 프로젝트가 시작되면 구성 클래스가 초기화됩니다.
3. API 문서 정보를 향상시킵니다
공개 인터페이스 sonarControlleri {@apioperation (value = "프로젝트 그룹의 소나에 해당하는 URL 정보 받기", notes = "notes ="ID를 기반으로 프로젝트 그룹의 소나에 해당하는 URL 정보 받기 "//이 주석을 사용하여 인터페이스 방법 정보를 사용하여 @apiimplicitparams (@apiimplicitparam (@apiimplicitparam (@apiimplicitparam)" "long", paramtype = "path")}) //이 주석을 사용하여 메소드 매개 변수 정보를 설명하십시오. 여기서 Paramtype 매개 변수는 경로로 구성되어야한다는 점에 유의해야합니다. 그렇지 않으면 ui @getmapping ( "/get/{id}")의 인터페이스 메소드에 액세스 할 때 오류가보고됩니다. @apioperation (value = "프로젝트 그룹 소나에 해당하는 모든 URL 정보 가져 오기") @getMapping ( "/get/all") 목록 <Sonarurl> getAll (); } 참고 : Paramtype는 매개 변수의 유형을 나타내고 선택적 값은 "경로", "body", "쿼리", "헤더", "형태"입니다.
4. 반환 유형 정보를 향상시킵니다
@Entity (name = "sonar_url") 공개 클래스 Sonarurl은 시리얼화할 수있는 { / ** * / private static final long serialversionuid = 1L; @apimodelProperty (value = "기본 키", hidden = false, notes = "기본 키, 숨겨진", 필수 = true, datatype = "long") //이 주석을 사용하여 속성 정보를 설명합니다. Hidden = true 일 때이 속성은 API @id @generatedValue (전략 = GenerationType.Auto) 개인 Long ID에 표시되지 않습니다. @apimodelProperty (value = "url 링크 주소") @column (name = "url") 개인 문자열 URL; @apimodelProperty (value = "Project Group") @column (name = "team") 개인 문자열 팀; @apimodelProperty (value = "Department") @column (name = "Department") 개인 문자열 부서; ... Getter를 생략, 세터 방법 ...}5. 응용 프로그램을 시작하십시오
1. 브라우저를 입력하십시오 : http : // localhost : 7622/swagger-ui.html
2. 결과는 다음과 같습니다.
6. API 문서 액세스 및 테스트
Swagger는 API 인터페이스보기 기능을 제공하는 것 외에도 디버깅 및 테스트 기능을 제공합니다.
테스트 결과는 다음과 같습니다.
위는이 기사의 모든 내용입니다. 모든 사람의 학습에 도움이되기를 바랍니다. 모든 사람이 wulin.com을 더 지원하기를 바랍니다.