SpringBoot 에서 swagger 사용

4.567917.인터페이스 문 서 는 전후 단 개발 자 에 게 매우 중요 하 다.swagger 는 open api 규범 을 바탕 으로 오픈 소스 도 구 를 구축 하 는 것 이다swagger 구성 요소
swagger editor 브 라 우 저 편집기 기반,
swagger ui 시각 화 ui 설명 파일 을 보 여 줍 니 다.
swagger inspector 는 ui 구성 요소 와 비슷 합 니 다.더 많은 정 보 를 되 돌려 주 고 요청 한 실제 인 자 를 저장 합 니 다.
spring fox 는 코드 에 따라 인터페이스 문 서 를 만 들 수 있 기 때문에 설명 파일 은 항목 에 따라 달라 집 니 다.수 동 으로 업데이트 하지 않 아 도 됩 니 다.
springboot 가 져 오기 spring-fox 의존 은 wagger 를 가 져 온 것 입 니 다.
시작 클래스 에@Enableswagger 2 주 해 를 추가 합 니 다.이 주 해 를 추가 하면 시작 항목 이 swagger 구성 요 소 를 시작 하고 현재 항목 의 모든 컨트롤 러 를 검색 합 니 다.
swagger-ui 방문
프로젝트 시작 후 브 라 우 저 에 입력http://ip:port/swagger-ui.html
swagger-ui 에서 시각 화 된 작업 항목 인터페이스,
swagger 설정프로젝트 에 SwaggerConfig 설정 대상 을 만들어 문서 내용 을 설정 할 수 있 습 니 다.
Docket 대상 은 이 대상 을 통 해 설명 파일 정 보 를 설정 합 니 다.
apis()방법 을 통 해 어떤 가방 의 내용 이 스 캔 되 었 는 지 설정 합 니 다.
상용 주해
@Api
클래스 주석 이 전체 클래스 생 성 인터페이스 정 보 를 제어 하 는 내용 입 니 다.속성 tags 류 의 이름 description 설명
@ApiOperation 방법 에 적 힌 주석,방법 설명,속성 value 방법 설명 notes 알림 정보
@Apiparam 방법 매개 변수 에 적 힌 주 해 는 매개 변 수 를 설명 하 는 데 사 용 됩 니 다.필수 항목 인지,속성 은 name 매개 변수 이름 value 매개 변수 설명 required 가 필요 한 지 설명 합 니 다.
@ApiModel 은 클래스 에 대한 설명 입 니 다.주로 실체 클래스 에 적 용 됩 니 다.속성 value 클래스 이름,description 은 설명 입 니 다.
@Api Modelproperty 는 방법 이나 속성 에 적용 할 수 있 으 며,방법 매개 변수 가 응용 유형 일 때 정의 설명 을 할 수 있 습 니 다.
@Apilgnore 는 클래스 방법 상의 매개 변수 에 사용 되 며 무시 되 었 음 을 표시 합 니 다.
전후 단 분리
보통 vue+springboot 사용
백 엔 드:백 엔 드 제어 층 서비스 층 데이터 액세스 층
전단:전단 제어 층 시도 층
앞 뒤 상호작용 API
springboot 프로젝트 가 져 오기 의존 도 를 만 듭 니 다.

swagger 인터페이스 보기 시작

swagger 설정
swagger 는 자신의 설정 인 스 턴 스 대상 Docket 이 있 습 니 다.
이 대상 방법 에는 여러 속성 이 있 습 니 다.
apiinfo 속성 은 swagger 디 스 플레이 를 설정 하 는 정보 입 니 다.
select()스 캔 인터페이스 설정
groupname()api 문서 의 그룹 설정 여러 개의 Docket 인 스 턴 스 를 설정 하면 여러 개의 그룹,여러 개의@bean 을 실현 할 수 있 습 니 다.



SpringBoot 에서 swagger 의 사용 에 관 한 이 글 은 여기까지 소개 되 었 습 니 다.더 많은 swagger 의 사용 내용 은 예전 의 글 을 검색 하거나 아래 의 관련 글 을 계속 찾 아 보 세 요.앞으로 도 많은 응원 부 탁 드 리 겠 습 니 다!