code1丝袜哥

启动admin微服务，访问地址：http://localhost:9001/swagger-ui.html

在Java类中添加Swagger的注解即可生成Swagger接口文档，常用Swagger注解如下：
@Api：修饰整个类，描述Controller的作用
@ApiOperation：描述一个类的一个方法，或者说一个接口
@ApiParam：单个参数的描述信息
@ApiModel：用对象来接收参数
@ApiModelProperty：用对象接收参数时，描述对象的一个字段
@ApiResponse：HTTP响应其中1个描述
@ApiResponses：HTTP响应整体描述
@ApiIgnore：使用该注解忽略这个API
@ApiError ：发生错误返回的信息
@ApiImplicitParam：一个请求参数
@ApiImplicitParams：多个请求参数的描述信息



@ApiImplicitParam属性： 
 1paramType---查询参数类型 
 path query参数   body以流的形式提交 仅支持POST  
 header参数在request headers 里边提交
 form以form表单的形式提交 仅支持POST
2 dataType--参数的数据类型 Long String
3name-接收参数名
4value 
5required-true false
6defaultValue-默认值

1第一步

  model中引入<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
</dependency>

2- 在heima-leadnews-admin工程的config包中添加一个配置类

package com.heima.admin.config;

import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfiguration {

   @Bean
   public Docket buildDocket() {
      return new Docket(DocumentationType.SWAGGER_2)
              .apiInfo(buildApiInfo())
              .select()
              // 要扫描的API(Controller)基础包
              .apis(RequestHandlerSelectors.basePackage("com.heima.admin.controller"))
              .paths(PathSelectors.any())
              .build();
   }

   private ApiInfo buildApiInfo() {
      Contact contact = new Contact("黑马程序员","","");
      return new ApiInfoBuilder()
              .title("平台管理API文档")
              .description("平台管理服务api")
              .contact(contact)
              .version("1.0.0").build();
   }
}

3AdChannelController中添加Swagger注解

@RestController
@RequestMapping("/api/v1/channel")
@Api(tags = "频道管理",description = "频道管理API")
public class AdChannelController {

    @Autowired
    private IAdChannelService adChannelService;

    @ApiOperation(value = "根据名称分页查询频道列表")
    @ApiImplicitParam(name = "dto", value = "频道请求对象", required = true, dataType = "ChannelDto") }

}

4ChannelDto

@Data
public class ChannelDto extends PageRequestDto { 
     * 频道名称 
    @ApiModelProperty("频道名称")
    private String name;
}

5PageRequestDto

@Setter
public class PageRequestDto { 
    @ApiModelProperty(value="每页显示条数",required = true)
    protected Integer size;
    @ApiModelProperty(value="当前页",required = true)
    protected Long page;   
}