eclipse内置swagger。maven项目spring boot框架

最新推荐文章于 2021-12-15 16:03:32 发布

SZ_紫衣

最新推荐文章于 2021-12-15 16:03:32 发布

阅读量246

点赞数

分类专栏：个人

本文链接：https://blog.youkuaiyun.com/qq_16977687/article/details/104778367

版权

个人专栏收录该内容

42 篇文章

订阅专栏

本文介绍了如何在Eclipse的Maven Spring Boot项目中集成并配置Swagger，包括添加依赖、配置Swagger，以及启动项目后如何访问Swagger UI。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1.添加依赖

<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>

        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>

2.添加swagger配置

import org.springframework.context.annotation.Bean;
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;
@Configuration
@EnableSwagger2
public class swaggerConfig {
	@Bean
	public Docket createRestApi() {
		return new Docket(DocumentationType.SWAGGER_2)
				.groupName("controller")
				.apiInfo(apiInfo())
				.select()
				.apis(RequestHandlerSelectors.basePackage("com.pusamm"))//项目包名
				.paths(PathSelectors.any()).build();
	}
 
 
	private ApiInfo apiInfo() {
		return new ApiInfoBuilder().title("移动C2M RESTful API")
				.description("swagger-ui")
				.termsOfServiceUrl("").version("1.0").build();
}

3.细节配置
在这里插入图片描述

@Slf4j
@Api(value = "Api Documentation")
@RestController
@RequestMapping("api/test")
public class ApisController {
    private final CabinetInformationService cabinetInformationService;
    

   public ApisController(final CabinetInformationService cabinetInformationService) {
	   this.cabinetInformationService = cabinetInformationService;
    }
	  
      @ApiAbility(permission = true)
	  @ApiOperation(value = "1.柜子信息查询接口", notes = "根据业务方id查询柜子的信息")
	  @PostMapping("/cabinet/query")
	  public List<CabinetQueryBack> cabinetInformationQuery(CabinetQuery req) {
		  List<CabinetQueryBack> list = null;
	      try {
	    	  list = cabinetInformationService.query(req);
	      }catch (Exception e) {
	    	  logger.error("柜子信息查询接口出错:{}", e.getMessage(), e);
	      }
	      return list;	  
	  }