어떻게 swagger 2 를 통합 하여 Restful API 를 구축 합 니까?

이 글 은 swagger 2 를 통합 하여 Restful API 를 구축 하 는 방법 을 소개 하 였 으 며,예시 코드 를 통 해 매우 상세 하 게 소개 하 였 으 며,여러분 의 학습 이나 업무 에 대해 어느 정도 참고 학습 가 치 를 가지 고 있 으 므 로 필요 한 분 들 은 참고 하 시기 바 랍 니 다.
pom.xml 에서 버 전 관리

<swagger.version>2.8.0</swagger.version>

taosir-api 의 pom.xml 에 의존 설정 을 추가 합 니 다.

<!-- swagger start -->
<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger2</artifactId>
  <version>${swagger.version}</version>
</dependency>
<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger-ui</artifactId>
  <version>${swagger.version}</version>
</dependency>

설정 클래스 추가

package cn.taosir.api.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@EnableSwagger2
@Configuration
public class SwaggerConfiguration {
  @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        //             
        //          ,        
        //@ApiIgnore   ,          swagger2     
        .apis(RequestHandlerSelectors.basePackage("cn.taosir.api.controller"))
        .paths(PathSelectors.any())
        .build();
  }
  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("           ")
        .version("1.0")
        .description("API   ")
        .build();
  }
}

제어 층 에 해당 하 는 주 해 를 추가 합 니 다.

package cn.taosir.api.controller.dreamhouse;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
import cn.taosir.service.dreamHouse.UserService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
@RestController
@Api(value = "    " ,tags = {"     "})
public class UserController {
  @Autowired
  private UserService userService;
  
  @ApiOperation(value="    ", notes="            ")
  @RequestMapping(value="/test",method=RequestMethod.GET)
  public String test() {
    return userService.test();
  }
}

순서대로 시작 하 다
taosir-eureka 등록 센터
taosir-dream House 서비스 제공 자
서비스 소비자
접근 주소http://localhost:8765/swagger-ui.html#


이상,통합 swagger 2 Restful API 구축
아래 에 주해 참고 표를 동봉 합 니 다.

@Api：       ，       
  tags="       ，   UI        "
  value="        ， UI      ，       "
 
@ApiOperation：        ，       、  
  value="       、  "
  notes="       "
 
@ApiImplicitParams：        ，        
  @ApiImplicitParam：  @ApiImplicitParams   ，             
    name：   
    value：       、  
    required：       
    paramType：        
      ・ header -->        ：@RequestHeader
      ・ query -->        ：@RequestParam
      ・ path（  restful  ）-->        ：@PathVariable
      ・ body（   ）
      ・ form（   ）  
    dataType：    ，  String，   dataType="Integer"    
    defaultValue：      
 
@ApiResponses：        ，      
  @ApiResponse：  @ApiResponses ，               
    code：  ，  400
    message：  ，  "       "
    response：      
 
@ApiModel：      ，             
      （      post     ，  @RequestBody     ，
              @ApiImplicitParam         ）
@ApiModelProperty：     ，        

이상 이 바로 본 고의 모든 내용 입 니 다.여러분 의 학습 에 도움 이 되 고 저 희 를 많이 응원 해 주 셨 으 면 좋 겠 습 니 다.