Swagger的使用说明

最新推荐文章于 2024-02-21 16:02:47 发布

蓝黑墨水

最新推荐文章于 2024-02-21 16:02:47 发布

阅读量107

点赞数

分类专栏：学习文章标签： spring

本文链接：https://blog.csdn.net/lanxiaziyi/article/details/109295208

版权

学习专栏收录该内容

146 篇文章 0 订阅

订阅专栏

文章目录

1，pom.xml中添加
2,定义Swagger2的配置文件
3，在相关的函数前面加上。

首先使用springboot搭建一个简单的web服务器。
保证 http://127.0.0.1:12151/hello 能正常输出结果。
这里的端口我自己指定的

我们使用的是 Swagger 来管理前后端的接口的。

1，pom.xml中添加

<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger2</artifactId>
	<version>2.8.0</version>
</dependency>
<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger-ui</artifactId>
	<version>2.8.0</version>
</dependency>
<dependency>
	<groupId>javax.xml.bind</groupId>
	<artifactId>jaxb-api</artifactId>
</dependency>

不加 jaxb-api 的话会报异常的。 Error creating bean with name ‘xmlModelPlugin’
如果遇到问题，就赶紧在网上搜，自己憋不出来的~

2,定义Swagger2的配置文件

package com.example.testswagger.controller;

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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class Swagger2 {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.testswagger"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("springboot利用swagger构建api文档")
                .description("简单优雅的restfun风格，http://blog.csdn.net/xx")
                .termsOfServiceUrl("http://blog.csdn.net/xx")
                .version("1.0")
                .build();
    }

}

其中 apis 里面写的是路径，后面

3，在相关的函数前面加上。

方式1

@ApiOperation(value = "添加手机终端设备信息")
@PostMapping(value="/hello3")
public String sayHello3(@RequestBody JSONObject jsonParam, HttpServletRequest request) {
	return "robin:hello world 3:"+ jsonParam.toJSONString();
}

方式2

@ApiOperation(value="测试hello2接口")
@ApiResponse(code=200,message = "OK")
@RequestMapping(value="/hello2",method = RequestMethod.GET)
public String sayHello2(@RequestParam String name)
{
    return  "robin:hello world2:"+name;
}

方式3

    @ApiOperation(value="获取用户详细信息", notes="根据url的id来获取用户详细信息")
    @ApiImplicitParam(name = "name", value = "用户名字", required = true, dataType = "String", paramType = "path")
    @GetMapping(value="/hello")
    public String sayHello()
    {
        return  "hollowed";
    }

补充

   /** 
   * 设备IMEI2，不插卡的时候可以获取到 
   */
    @ApiModelProperty("设备IMEI2，不插卡的时候可以获取到")
    private String deviceImei2;

    /**
     * 设备MEID，预留
     */
    @ApiModelProperty("设备MEID，预留")
    private String deviceMeid;