회사가 Swagger를 사용하지 않았거나 Swagger에 대해 들어 본 적이 있다면,이 블로그를 서두르고 5 분 빠르고 바보 스타일의 통합을 배우지 만 간단한 응용 프로그램은 반드시 충격을 줄 것입니다.
먼저, Swagger에 대한 간략한 소개를하겠습니다. Swagger는 백엔드 개발을위한 마법의 도구이며 프론트 엔드 커뮤니케이션을위한 채널입니다. Swagger로 무엇을 할 수 있습니까? 우선, 기본적으로 미래에 단위 테스트에 작별 인사를 할 수 있습니다. 둘째, 더 이상 인터페이스 문서를 작성할 필요가 없으며 문서를 작성한 후에는 문서를 유지할 필요가 없습니다. Swagger는 HTTP 요청을 완전히 시뮬레이션 할 수 있으며, 들어오는 매개 변수와 실제 조건의 차이는 거의 0입니다. 이것을 말하면서, 몇 가지 정보를 만들어 봅시다!
통합 된 4 부 :
1 단계 : 두 가지 종속성을 가져옵니다. Maven 프로젝트가 아니라면 Jar 패키지를 찾을 수 있습니다. 두 가지만 필요하다는 것을 기억하십시오. 다른 튜토리얼에서 7 ~ 8 개를 소개하는 것을 보았습니다.
<pectionency> <groupid> io.springfox </groupid> <artifactid> springfox-swagger2 </artifactid> <버전> 2.6.1 </version> </dependency> <prectionency> <groupid> io.springfox </groupid> <artifactid> springfox-swagger-ui </artifactid>
2 단계 : 클래스 추가 (다음을 복사하면 패키지 이름 및 주소를 수정할 수 있습니다).
/** * swagger configuration * * @author wq * @since 2017-05-16 */ @enablewebmvc @enableswagger2 @configurationpublic class swaggerconfig {@bean public docket createrestapi (return new docket (documentationtype.swagger_2)) .apiinfo (). .apis (requestHandlersElector.basePackage ( "com.z*.b*.c*.controller")) // 여기에서 패키지 이름을 수정합니다. } private apiinfo apiinfo () {new apiinfobuilder () .title ( "인터페이스 목록 v1.1.0") // one, any. 자신의 IP : Port .Contact ( "laowu") // 중요하지 않습니다 (여기서 저자의 별칭은 다음과 같습니다) .version ( "1.1.0") .build (); }} 3 단계 : MVC 구성 파일에 다음 구성을 추가하십시오. 파일이 dispatcher.xml이라고 할 수 있습니다! (복사, 수정이 필요하지 않음)
<MVC : 리소스 매핑 = "Swagger-ui.html"위치 = "classpath :/meta-inf/resources/"/>> <mvc : 리소스 매핑 = "/webjars/**"location = "classpath :/meta-inf/resources/webjars/"/>
4 단계 : 메소드와 매개 변수에 주석을 추가하십시오
방법:
@apioperation (value = "튜토리얼", httpmethod = "post", notes = "튜토리얼")
레지스트리에 넣으십시오.
@apiparam (필수 = true, name = "test", value = "튜토리얼 매개 변수")
일부 친구들이 이해하지 못할까 걱정하므로 사진을 찍어 봅시다!
5 단계 : 서비스를 시작하고 브라우저에 입력하십시오.
http : // ip : port/swagger-ui.html
다음 화면이 나타나면 작업이 완료되었음을 의미합니다.
참고 : 프로젝트에서 인터셉터를 사용하는 경우 Swagger 리소스를 해제하십시오 (다음 구성을 직접 복사 할 수 있습니다.
<MVC : 제외 맵핑 경로 = "/Swagger*/**"> </mvc : excludemapping> <mvc : 제외 매핑 경로 = "/v2/**"> </mvc : 제외 맵핑> <mvc : 제외 맵핑 경로 = "/webjars/**"> </mvc : 제외 매핑>
위는이 기사의 모든 내용입니다. 모든 사람의 학습에 도움이되기를 바랍니다. 모든 사람이 wulin.com을 더 지원하기를 바랍니다.