zoukankan      html  css  js  c++  java
  • 使用Swagger生成简单接口文档

    使用swagger通过简单的配置可以生成简单的接口文档;

    依赖包:

    // Swagger2
    compile 'io.springfox:springfox-swagger2:2.8.0'
    compile 'io.springfox:springfox-swagger-ui:2.8.0'

    启动类添加配置:

    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    @EnableAutoConfiguration
    public class ShowCaseApplication {
        
        public static void main(String[] args) {
            SpringApplication.run(ShowCaseApplication.class, args);
        }
    }

    配置类:

    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.ComponentScan;
    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.Contact;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spring.web.plugins.Docket;
    import springfox.documentation.swagger2.annotations.EnableSwagger2;
    
    @Configuration
    @ComponentScan(basePackages = { //"com.a.controller", //
            })
    @EnableSwagger2
    public class AutoConfiguration {
    
        @Bean
        public Docket docketCommon() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .groupName("test").select()
                    .apis(RequestHandlerSelectors.basePackage("com.a.controller"))
                    .paths(PathSelectors.any())
                    .build()
                    .apiInfo(new ApiInfoBuilder().
                            title("test Restful API").
                            description("接口API").
                            contact(new Contact("", "", "")).
                            version("1.0").
                            build());
        }
    }

    接口注释:在controller里的接口上面添加标识

    	@ApiOperation(nickname = "getList", value = "获取列表。")
    	@Override
    	public List<String> getList(
    			@RequestBody @ApiParam(name = "请求对象", value = "传入json格式", required = true) TestRequest request) {
    		return null
    	}
    

      

  • 相关阅读:
    剑指Offer-用两个栈实现队列
    剑指Offer-从尾到头打印链表
    滑动门技术实现
    解决keil5中文注释乱码方法
    faker数据填充详解
    redis在微博与微信等互联网应用笔记
    JDBC插入中文数据出现?号地解决问题
    idea配置less自动编译
    idea使用Vue的v-bind,v-on报错
    idea 代码部分格式化
  • 原文地址:https://www.cnblogs.com/liangblog/p/9716064.html
Copyright © 2011-2022 走看看