springboot2.0入门（五）--swagger2接口API构建

ゝ一纸荒年。 2023-06-03 06:57 20阅读 0赞

一、特点

*  代码变，文档变。只需要少量的注解，Swagger 就可以根据代码自动生成 API 文档，很好的保证了文档的时效性。
 *  跨语言性，支持 40 多种语言。
 *  Swagger UI 呈现出来的是一份可交互式的 API 文档，我们可以直接在文档页面尝试 API 的调用，省去了准备复杂的调用参数的过程。
 *  还可以将文档规范导入相关的工具（例如 SoapUI）, 这些工具将会为我们自动地创建自动化测试

二、代码

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

引入maven依赖

/**
     * @author Levi
     * @date 2019/10/4 22:54
     */
    @Configuration
    @EnableSwagger2
    public class Swagger2Config {
        @Bean
        public Docket createRestApi() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    //扫描basePackage包下面的“/rest/”路径下的内容作为接口文档构建的目标
                    .apis(RequestHandlerSelectors.basePackage("com.liyu.helloworld"))
                    .paths(PathSelectors.regex("/rest/.*"))
                    .build();
        }
    
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder()
                    .title("springboot利用swagger构建api文档")
                    .description("简单优雅的restfun风格")
                    .termsOfServiceUrl("http://www.levi.com")
                    .version("1.0")
                    .build();
        }
    }

访问地址：[http://localhost:8090/swagger-ui.html\#/][http_localhost_8090_swagger-ui.html]

![1675975-20191004230517771-13876870.png][]

使用的小技巧：

@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：用在属性上，描述响应类的属性

@ApiModel @ApiModelProperty  可以用来详细注释返回的类信息

![1675975-20191004231256597-546021441.png][]

转载于:https://www.cnblogs.com/liweiweicode/p/11623645.html

[http_localhost_8090_swagger-ui.html]: http://localhost:8090/swagger-ui.html#/
[1675975-20191004230517771-13876870.png]: /images/20230601/3997711db954409ab245af21e6c48853.png
[1675975-20191004231256597-546021441.png]: /images/20230601/6b2ec08e87c84ea390324653487749ac.png