SpringBoot에서 Swaggerui를 사용하는 방법에 대한 자세한 설명

멋진

Swagger는 서비스 인터페이스를 정의하는 데 사용되는 언어 독립적 사양 및 프레임 워크이며 주로 편안한 API를 설명하는 데 사용됩니다. API 용 우수한 문서 및 클라이언트 라이브러리를 만드는 데 중점을 둡니다. Swagger 지원 API는 API 메소드에 대한 대화식 문서를 생성 할 수있어 사용자가 시각적으로 실험하고 요청 및 응답, 헤더 파일 및 반환 코드를 보면 API의 기능을 발견 할 수 있습니다.

Swagger는 API 문서를 정의하는 데 사용됩니다.

혜택:

1. 전면 및 백엔드 별도의 배송
2. API 문서는 매우 명확합니다
3. 테스트 중에 더 이상 컨트롤러에 액세스하기 위해 브라우저에 URL 입력을 사용할 필요가 없습니다.
4. URL을 입력하는 전통적인 방법은 게시물 요청에서 매개 변수를 전달하는 데 더 문제가됩니다 (물론 Postman과 같은 브라우저 플러그인을 사용할 수 있습니다).
5. 스프링 부츠와 스와 거의 통합이 더 간단합니다

Springboot는 Swaggerui를 포함합니다

단계

1. 자르 패키지 소개

 <pectionency> <groupid> io.springfox </groupid> <artifactid> springfox-swagger-ui </artifactid> <version> 2.2.2 </version> <scope> compile </scope> </fectionency> <pelection> <groupid> io.springfox </groupIds> springfox> <버전> 2.2.2 </버전> <Scope> 컴파일 </scope> </fectionency>

2. SpringBoot를 기반으로 SwaggerConfig 구성

 @configuration @enableswagger2public class swaggerconfig {@bean public docket newsapi () {// new Docket (le Docket Docket = New Docket (DocumentationType.wagger_2); docket.enable (true); docket.apiinfo (apiinfo ()). select (). 경로 (pathselectors.any ()). build (); 반환 도켓; } private apiinfo apiinfo () {return new apiinfobuilder (). 제목 ( "주문 센터 테스트 플랫폼"). 설명 ( "여기서 프로젝트의 모든 인터페이스를 탐색하고 관련 테스트 도구를 제공 할 수 있습니다"). .termsofserviceurl ( "http://www-03.ibm.com/software/sla/sladb.nsf/sla/bm?open") }}

3. WebConfig 구성 지침

여기에주의를 기울여야하는 문제가 있습니다. WebConfig가 WebMvcConfigurerAdapter를 직접 상속하는 대신 WebMVCautoConfigurationAdapter를 상속 받으십시오. 그렇지 않으면 Swagger 페이지가 해제되지 않습니다.

 @configuration @enablewebmvcpublic class webconfig는 webmvcautoconfigurationAdapter {@override public void addcorsmappings (corsregistry registry) {registry.addmapping ( "/**"); } @Bean public static propertySourcesPlaceHolderConfigurer PropertySourcesPlaceHolderConfigurer () {새로운 PropertySourcesPlaceHolderConfigurer (); } @bean public filter char 문자 encodingfilter.setencoding ( "UTF-8"); articationencodingfilter.setforceencoding (true); Return CharacterEncodingFilter; } @Bean Public Mapping Jackson2httpMessageConverter converter () {MappingJackson2httpmessageConverter converter = new Mapping Jackson2httpmessageConverter (); 반환 변환기; } @Bean public viewResolver getViewResolver () {내부 resourceViewResolver resolver = new InternalResourceViewResolver (); Resolver.setViewClass (jstlView.class); resolver.setprefix ( "/jsp"); resolver.setsuffix ( ". jsp"); 리턴 리졸버; } @bean public 표준 ergevletmultipartresolver getStandardServletMultipartresolver () {return new 표준 ervletmultipartresolver (); }}

4. Swaggerui 페이지 액세스

http : // localhost : 8080/projectname/swagger-ui.html#!/

위는이 기사의 모든 내용입니다. 모든 사람의 학습에 도움이되기를 바랍니다. 모든 사람이 wulin.com을 더 지원하기를 바랍니다.