API调试工具

liubo525

已于 2025-03-19 11:22:17 修改

阅读量264

点赞数

CC 4.0 BY-SA版权

分类专栏：工具文章标签： java

于 2021-09-10 17:50:21 首次发布

本文链接：https://blog.csdn.net/weixin_42607437/article/details/120227161

工具专栏收录该内容

7 篇文章

订阅专栏

Swagger

swagger是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

实现

maven导入Swagger

<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>

创建Swagger2配置类

/**
 * @program: jpademo
 * @description: Swagger
 * @author: ZengGuangfu
 * @create 2018-10-24 10:12
 */

@Configuration
@EnableSwagger2
public class Swagger {

   @Bean
   public Docket docket(){
       return new Docket(DocumentationType.SWAGGER_2)
         .apiInfo(apiInfo())
         .select()
         .apis(RequestHandlerSelectors.basePackage("com.example.springbootjpa.jpademo.controller"))
         .paths(PathSelectors.any())
         .build();
   }

   public ApiInfo apiInfo(){
       return new ApiInfoBuilder()
         .title("利用swagger2构建的API文档")
         .description("用restful风格写接口")
         .termsOfServiceUrl("")
         .version("1.0")
         .build();
   }
}

如上所示，docket() 方法创建Docket的Bean对象，apiInfo()则是创建ApiInfo的基本信息。

注解及其说明

注解	说明
@Api	用在类上，说明该类的主要作用。
@ApiOperation(value = “主表导出”, produces = “application/octet-stream”)	用在方法上，给API增加方法说明。
@ApiImplicitParams	用在方法上，包含一组参数说明。
@ApiImplicitParam	用来注解来给方法入参增加说明。
@ApiResponses	用于表示一组响应。
@ApiResponse(code = x,message = “xx”,response = String.class)	用在@ApiResponses中，一般用于表达一个错误的响应信息
@ApiModel	用在返回对象类上，描述一个Model的信息（一般用在请求参数无法使用@ApiImplicitParam注解进行描述的时候）
@ApiModelProperty	描述一个model的属性