一款非常实用，快速开发和调试api工具---swagger

╰+攻爆jí腚メ 2022-05-16 03:48 172阅读 0赞

一、配置方法  
1、在pom.xml配置文件中增加依赖：

<dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger2</artifactId>
                <version>2.7.0</version>
            </dependency>
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger-ui</artifactId>
                <version>2.7.0</version>
            </dependency>

第一个依赖表示将swagger集成进来  
第二个人依赖表示集成的swagger支持ui视图，方便查看和调试API接口。

2、在项目中增加SwaggerConfig

package xxxxxx;
    
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.context.annotation.Profile;
    import springfox.documentation.builders.PathSelectors;
    import springfox.documentation.builders.RequestHandlerSelectors;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spring.web.plugins.Docket;
    import springfox.documentation.swagger2.annotations.EnableSwagger2;
    
    /**
     * Created by xxx on 2017/8/10.
     */
    @Configuration
    @Profile("!production")
    @EnableSwagger2
    public class SwaggerConfig {
    
        @Bean
        public Docket api() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("xxxxx"))
                    .paths(PathSelectors.any())
                    .build();
        }
    }

3、在启动类中引用上面的Config类，加载进来

/**
     * Created by xxxxx
     */
    @SpringBootApplication
    @ComponentScan(value = {"xxxx.*"},
            excludeFilters = {@ComponentScan.Filter(type = FilterType.REGEX,pattern = {"com.lenovo.chinaservice.pscm.order.*","xxxxx.*"})})
    @EnableAspectJAutoProxy
    @EnableDiscoveryClient
    @EnableGlobalMethodSecurity(securedEnabled = true, prePostEnabled = true)
    @IntegrationComponentScan
    @EnableFeignClients
    @EnableCaching
    @EnableRabbit
    public class PscmQualityTestApplication {
    
    
        @Value("${leaderLatch.index}")
        private String leaderLatchIndex;
    
    
        public static void main(String[] args) {
            Object[] sources = {PscmQualityTestApplication.class, DataSourceConfig.class, FeignClientConfig.class, SwaggerConfig.class, HttpSessionConfig.class, CommonConfig.class, SecurityConfig.class};
            SpringApplication.run(sources, args);
        }

二、如何使用  
1、在Controller中使用

package xxxx
    import ...;
    
    import io.swagger.annotations.Api;
    import io.swagger.annotations.ApiOperation;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.security.core.context.SecurityContextHolder;
    import org.springframework.validation.BindingResult;
    import org.springframework.web.bind.annotation.*;
    
    import javax.validation.Valid;
    import java.util.List;
    
    
    
    @RestController
    @Api(value="doacheck", description="xxxx")
    public class DoaCheckController {
    
        @Autowired
        private DoaCheckService doaCheckService;
    
        @Autowired
        private ResultVOBuilder resultVOBuilder;
    
    
        @ApiOperation(value = "新建DOA复测步骤")
        @RequestMapping(value = "/doaCheck/add", method = RequestMethod.POST)
        public ResultVO<DoaCheckAddVO> saveDoaCheck(@Valid @RequestBody DoaCheckAddVO doaCheckAddVO, BindingResult bindingResult) {
    
            ResultVO<DoaCheckAddVO> v = ValidateUtils.validateBasicInfo(resultVOBuilder,bindingResult);
            //不合符规则
            if(!v.isSuccess()){
                return v;
            }
            PscmUser pscmUser = (PscmUser) SecurityContextHolder.getContext().getAuthentication().getDetails();
            Long createorId = pscmUser.getUserId();
            String createorName = pscmUser.getPersonName();
    
            return doaCheckService.saveDoaCheck(doaCheckAddVO,createorId,createorName);
        }

2、查看测试接口  
![这里写图片描述][70]

10.103.237.131是服务器ip，如果是本地就是127.0.0.1或localhost  
中文描述信息就是在Controller中指定的描述信息  
/doaCheck/add 是指定的接口地址  
在图片右下角区域是Date Type 表示接口的指定接口参数对象，对象中包括属性信息  
![这里写图片描述][70 1]  
在parameters中录入接口参数信息，点击Try it out !按钮  
![这里写图片描述][70 2]  
Response Body 返回调用接口执行的成功或者失败信息，格式根据自己项目情况格式不一样。

**总结：swagger是一款非常好用的定义api接口和调试api接口的工具，在实际项目过程中，使用非常方便，定义好接口后，直接将接口地址发给需要的人，接口信息一目了然，调试接口速度也非常快。**

[70]: /images/20220516/84fd40b03a0249419f5e65468c24238a.png
[70 1]: /images/20220516/553440da65b34351a0a6f8df0e8e45fd.png
[70 2]: /images/20220516/cdcbdc03fea94200be3db87b0687e805.png