一文学会Swagger2

最新推荐文章于 2023-01-10 01:07:12 发布
最新推荐文章于 2023-01-10 01:07:12 发布
阅读量228 收藏 4
点赞数
分类专栏： 工具 文章标签： swagger2 Restful
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_38112165/article/details/109489947
版权

Swagger2

目录 介绍 搭建及使用 常用注解介绍 Api文档导出

Swagger2介绍

官话

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

白话

现在很多项目都是前后端分离的，后端一般都需要自己手写维护一个后台api接口文档，提供给前台看，比较麻烦，而且还存在交流不及时的问题，这个工具可以实现自动生成一个Restful Api在线文档，可以对接口进行解释及测试，同样还支持在线文档导出为本地文档

LOGO

image-20201103222913991

官网

https://swagger.io

github

https://github.com/swagger-api

作用

自动生成接口文档，节省维护成本

image-20201104094912766

接口文档内可以实现在线接口测试

image-20201104095333054
image-20201104095603721

Swagger2搭建

  • 使用springboot整合Swagger2案例

  • 引入依赖

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

  • 在启动类上添加注解@EnableSwagger2

    @EnableSwagger2
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(BlogApplication.class, args);
    }

}

  • 编写Swagger2配置类Swagger2Config，进行相关配置

    @Configuration
@EnableSwagger2
public class Swagger2Config {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
            //调用下面写的配置api文档的基本信息方法
            .apiInfo(this.apiInfo())
            //配置映射路径前缀的意思，假如配置为"/blog"，后台requestmapping接口为/user/getById那么，访问路径就变成了/blog/user/getById
            .pathMapping("/")
            //创建api选择器,用于选择api
            .select()
            //apis配置api所在位置，下面apis的参数
            //any():扫描全部
            //none():全部不扫描
            //RequestHandlerSelectors.basePackage("com.xx.xx.controller")配置捕获请求所在的package
            //RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)配置有ApiOperation注解的方法才生成接口文档
            //RequestHandlerSelectors.withClassAnnotation(RestController.class)配置有RestController注解的类中的方法生成接口文档
            .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)
            //路径过滤
            //ant:指定路径
            //any:过滤全部
            //none:全部不过滤
            //regex:使用正则过滤
            .paths(PathSelectors.any())
            .build();
    }
    //配置接口文档的基本信息
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("api文档标题	eg XX系统接口api")
                .description("api文档描述 eg 提供XX功能的restful接口")
                .version("版本号 eg 1.0.0")
                .termsOfServiceUrl("服务条款URL")
                .license("许可证")
                .licenseUrl("许可证URL")
                .extensions("扩展信息，参数为List<VendorExtension> extensions")
                .build();
    }
}

  • 编写Result返回结果类，也可以不用

    public class SwagResult {
    //返回状态	eg,success,error
    private String status;
    //存放返回数据
    private Object result;
    public String getStatus() {
        return status;
    }
    public void setStatus(String status) {
        this.status = status;
    }
    public Object getResult() {
        return result;
    }
    public void setResult(Object result) {
        this.result = result;
    }
    public void success(Object result){
        this.status = "success";
        this.result = result;
    }
    public void error(Object result){
        this.status = "error";
        this.result = result;
    }
}

  • 编写控制器，并添加相应注解，目前先简单看一下代码，后面有各个注解的详细解释

    @RestController
@Api(value = "管理用户信息")
@RequestMapping("/blog/user")
public class UserController {
    @Autowired
    private UserService userService;
    @ApiOperation(value="得到全部用户", notes="获取全部用户")
    @GetMapping("/getAll")
    public SwagResult getAll(){
        SwagResult result = new SwagResult();
        try{
            result.success(userService.getList());
        }catch (Exception e){
            result.error(e.getClass().getName() + ":" + e.getMessage());
            e.printStackTrace();
        }
        return result;
    }
}

  • 在静态资源配置中将swagger2-ui.html映射到classpath:/META-INF/resouces/

    @Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/**").addResourceLocations("classpath:/static/");
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");
    }
}

  • 配置完成，在浏览器打开localhost:端口号/swagger-ui.html

    image-20201104094912766

常用注解介绍

说明：本次在介绍参数时，较低版本就被遗弃的参数在此不再介绍

  • @Api

    使用位置：用在请求类上，一般为controller上

    作用：表示对类的说明

    参数

    参数类型默认值描述
    tagsString[]“”说明该类的作用，非空时会覆盖value值
    valueString{""}描述类的作用，基本不用，tags就够了
    producesString“”设置MIME类型(output)列表，eg“application/json, application/xml”
    consumesString“”设置MIME类型(input)列表，eg“application/json, application/xml”
    protocolsString“”设置特定协议，eg http,https,ws,wss
    authorizationsauthorizations[]{@Authorization("")}获取授权列表
    hiddenbooleanfalse隐藏设置，参数为true时则在api文挡中隐藏

    总结

    一般就用tags参数，其他的除非特殊需要

    案例

    @RestController
@Api(tags = "用户信息管理Controller")
@RequestMapping("/user")
public class UserController {
    ...
}

    没用tags

    image-20201104103804906

    使用tags

    image-20201104103734685

  • @ApiOperation

    使用位置：用在类的请求方法上，一般就是controller内的请求方法

    作用：对方法进行说明

    参数

    参数类型默认值描述
    valueString“”描述方法的作用
    notesString“”方法的备注说明
    tagsString[]{""}方法描述，非空时将覆盖value值
    responseClass<?>Void.class响应类型
    responseContainerString“”返回对象容器的声明
    responseReferenceString“”指定对响应类型的引用
    httpMethodString“”请求方式,eg get,post
    nicknameString“”第三方工具唯一标识
    producesString“”设置MIME类型(output)列表，eg“application/json, application/xml”
    consumesString“”设置MIME类型(input)列表，eg“application/json, application/xml”
    protocolsString“”设置特定协议，eg http,https,ws,wss
    authorizationsauthorizations[]{@Authorization("")}获取授权列表
    hiddenbooleanfalse隐藏设置，参数为true时则在api文档中隐藏
    responseHeadersResponseHeader[]{@ResponseHeader( name = “”, response = Void.class )};响应头列表
    codeint200HTTP状态码
    extensionsExtension[]{@Extension( properties = {@ExtensionProperty( name = “”, value = “” )} )};扩展属性列表

    总结

    常用参数为value和notes，value对方法进行简单说明，notes进行补充，其他参数根据需要使用

    @ApiOperation和@Api都有value和tags参数，但是常用参数不同

    @ApiOperation用value和notes进行方法说明

    @Api使用tags进行类说明

    案例

    @ApiOperation(value="获取全部用户列表", notes="不需要参数")
@GetMapping("/getAll")
public SwagResult getAll(){
    SwagResult result = new SwagResult();
    try{
        result.success(userService.getList());
    }catch (Exception e){
        result.error(e.getClass().getName() + ":" + e.getMessage());
        e.printStackTrace();
    }
    return result;
}

    使用效果，没有使用，则没有方法说明

    image-20201104110400834

  • @ApiImplicitParam

    使用位置：直接用在请求方法上，或用在请求方法上@ApilmplicitParams注解中

    作用：对一个请求参数进行说明

    参数

    参数类型默认值描述
    nameString“”参数名，一般和解释的方法参数一致
    valueString参数的说明
    defaultValueString“”参数默认值
    requiredbooleanfalse是否必须传参
    accessString“”允许api文档中过滤参数
    allowMultiplebooleanfalse是否
    dataTypeString“”参数数据类型，eg Integer
    dataTypeClassClass<?>Void.class参数数据类型类对象
    paramTypeString“”参数的类型
    header获取时使用@RequestHeader
    query获取时使用@RequestParam
    path获取时使用@PathVariable
    body
    form
    exampleString“”单个示例
    examplesExampleExample({@ExampleProperty( mediaType = “”, value = “” )})参数示例，仅适用于BodyParameters
    typeString“”
    formatString“”
    allowEmptyValuebooleanfalse是否允许参数值为空
    readOnlybooleanfalse参数是否只读
    collectionFormatString“”

    总结

    常用参数为name，value，required，paramType，dataType,defaultValue等

    案例

    @ApiOperation(value="根据id获取用户信息", notes="输入String参数id来获取用户信息")
@ApiImplicitParam(name = "id", value = "用户id", required = true, dataType = "String")
@GetMapping("/getById")
public SwagResult getById(@RequestParam("id") String id){
    SwagResult result = new SwagResult();
    try{
        result.success(userService.getById(id));
    }catch (Exception e){
        result.error(e.getClass().getName() + ":" + e.getMessage());
        e.printStackTrace();
    }
    return result;
}

    效果

    image-20201104114156274

  • @ApiImplicitParams

    使用位置：直接用在请求发方法上

    作用：多个参数进行描述

    参数

    参数类型默认值描述
    valueApiImplicitParam[]ApiImplicitParam列表

    案例

    @ApiOperation(value="根据姓名和邮件查询用户信息", notes="输入String的anme和email来获取用户信息")
@ApiImplicitParams({@ApiImplicitParam(name = "name", value = "用户姓名", required = true, dataType = "String")
                    ,@ApiImplicitParam(name = "email", value = "用户邮箱", required = true, dataType = "String")})
@GetMapping("/getByNameEmail")
public SwagResult getByNameEmail(@RequestParam("name") String name,@RequestParam("email") String email){
    SwagResult result = new SwagResult();
    try{
        result.success(userService.getByNameEmail(name, email));
    }catch (Exception e){
        result.error(e.getClass().getName() + ":" + e.getMessage());
        e.printStackTrace();
    }
    return result;
}

    效果

    image-20201104120201866

  • @ApiParam

    使用位置：用在请求方法的括号中被描述参数的前面

    作用：参数的简要说明

    参数

    参数类型默认值描述
    nameString“”参数名，一般和解释的方法参数一致
    valueString参数的说明
    defaultValueString“”参数默认值
    requiredbooleanfalse是否必须传参
    accessString“”允许api文档中过滤参数
    allowMultiplebooleanfalse是否
    hiddenbooleanfalse参数是否隐藏
    exampleString“”单个示例
    examplesExampleExample({@ExampleProperty( mediaType = “”, value = “” )})参数示例，仅适用于BodyParameters
    typeString“”
    formatString“”
    allowEmptyValuebooleanfalse是否允许参数值为空
    readOnlybooleanfalse参数是否只读
    collectionFormatString“”

    总结

    因为在函数内，所以一般就只会用几个参数不会太多，太多的话可以使用@ApiImplicitParam

    案例

    @ApiOperation(value="根据姓名和邮件查询用户信息", notes="输入String的anme和email来获取用户信息")
@GetMapping("/getByNameEmail")
public SwagResult getByNameEmail(
    @ApiParam(name = "name", value = "用户姓名", required = true) String name
    ,@ApiParam(name = "email", value = "用户邮箱", required = true) String email){
    SwagResult result = new SwagResult();
    try{
        result.success(userService.getByNameEmail(name, email));
    }catch (Exception e){
        result.error(e.getClass().getName() + ":" + e.getMessage());
        e.printStackTrace();
    }
    return result;
}

    效果

    image-20201104125541459

  • @ApiResponse

    使用位置：用在请求的方法上，一般放在@ApiResponses里使用

    作用：表示一个响应信息,一般用来描述错误信息

    参数

    参数类型默认值描述
    codeintHTTP状态码
    messageString信息
    responseClass<?>Void.class抛出异常的类
    referenceString“”响应的引用类型
    responseHeadersResponseHeader[]{@ResponseHeader( name = “”, response = Void.class )}响应头列表
    responseContainerString“”响应容器类型
    examplesExample@Example({@ExampleProperty( value = “”, mediaType = “” )})示例

    案例1，单独使用@ApiResponse注解

    @ApiOperation(value="根据id获取用户信息", notes="输入String参数id来获取用户信息")
@ApiImplicitParam(name = "id", value = "用户id", required = true, dataType = "String")
@ApiResponse(code=404,message="请求路径没有或页面跳转路径不对")
@GetMapping("/getById")
public SwagResult getById(@RequestParam("id") String id){
    SwagResult result = new SwagResult();
    try{
        result.success(userService.getById(id));
    }catch (Exception e){
        result.error(e.getClass().getName() + ":" + e.getMessage());
        e.printStackTrace();
    }
    return result;
}

    效果，根据结果发现并没有起作用，404 Not Found是默认的值，没有变成我们写的message信息

    image-20201104131641388

    案例2，将@ApiResponse注解放在@ApiResponses里

    @ApiOperation(value="根据id获取用户信息", notes="输入String参数id来获取用户信息")
@ApiImplicitParam(name = "id", value = "用户id", required = true, dataType = "String")
@ApiResponses({
    @ApiResponse(code=404,message="请求路径没有或页面跳转路径不对")
})
@GetMapping("/getById")
public SwagResult getById(@RequestParam("id") String id){
    SwagResult result = new SwagResult();
    try{
        result.success(userService.getById(id));
    }catch (Exception e){
        result.error(e.getClass().getName() + ":" + e.getMessage());
        e.printStackTrace();
    }
    return result;
}

    效果，结果发现==@ApiResponse注解放在@ApiResponses里才起作用==

    image-20201104132055973

  • @ApiResponses

    使用位置：用在请求方法上

    作用：描述一组响应信息

    参数

    参数类型默认值描述
    valueApiResponse[]ApiResponse列表

    案例见@ApiResponse注解的案例

  • @ApiModel

    使用位置：用于响应类或参数类上，一般为Entity或者DTO，一般在响应数据当好是一个类的时候或者@ApiImplicitParam无法或过于复杂描述的时候

    作用：描述响应类的信息

    参数

    参数类型默认值描述
    valueString“”描述响应类
    descriptionString“”具体描述响应类的信息作用等
    parentClass<?>Void.class响应类负类的类对象
    discriminatorString“”鉴别器
    subTypesClass<?>[]{}
    referenceString“”响应类的引用类型

    总结

    一般就使用value和description进行描述响应类

    案例

    @ApiModel(value = "返回结果",description = "用于存储请求结果的状态及返回数据")
public class SwagResult {
	...
}

  • @ApiModelProperty

    使用位置：用在@ApiModel注解的类的属性上

    作用：对属性进行描述

    参数

    参数类型默认值描述
    valueString属性参数的说明
    nameString“”属性参数名
    allowableValuesString“”限制参数可以接收的值
    以逗号分隔的列表eg “1,2”
    范围值
    最大/最小值
    accessString“”允许api文档中过滤参数
    notesString“”属性参数备注信息
    dataTypeString“”属性参数类型
    requiredbooleanfalse是否必须有
    positionint0设置不同数值，实现调整参数在api文档中的位置
    hiddenbooleanfalse参数是否隐藏
    exampleString“”单个示例
    allowEmptyValuebooleanfalse是否允许参数值为空
    readOnlybooleanfalse参数是否只读
    extensionsExtension[]{@Extension( properties = {@ExtensionProperty( name = “”, value = “” )} )}扩展信息列表

案例

  @ApiModel(value = "返回结果",description = "用于存储请求结果的状态及返回数据")
  public class SwagResult {
      @ApiModelProperty(value = "状态",notes = "success表示成功，error表示失败",required = true)
      private String status;
      @ApiModelProperty(value = "结果",notes = "用于存储请求结果数据",required = true)
      private Object result;
      public String getStatus() {
          return status;
      }
      public void setStatus(String status) {
          this.status = status;
      }
      public void success(Object result){
          this.status = "success";
          this.result = result;
      }
      public void error(Object result){
          this.status = "error";
          this.result = result;
      }
      public Object getResult() {
          return result;
      }
      public void setResult(Object result) {
          this.result = result;
      }
  }

关闭Swagger2方法

当项目上线时需要关闭Swagger2，关闭方法如下

在Swagger2Config中进行关闭

@Configuration
@EnableSwagger2
public class Swagger2Config {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(this.apiInfo())
            .pathMapping("/")
            .select()
            .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)
            .paths(PathSelectors.any())
            .build().enable(false);	//在build()后加enable(false)进行关闭
    }
    //配置接口文档的基本信息
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("api文档标题	eg XX系统接口api")
                .description("api文档描述 eg 提供XX功能的restful接口")
                .version("版本号 eg 1.0.0")
                .termsOfServiceUrl("服务条款URL")
                .license("许可证")
                .licenseUrl("许可证URL")
                .extensions("扩展信息，参数为List<VendorExtension> extensions")
                .build();
    }
}

关闭效果
微信图片_20201104144706

Api文档导出

Api文档导出官方支持三种格式：markdown、asciidoc、confluence

导入pom依赖

<dependency>
    <groupId>io.github.swagger2markup</groupId>
    <artifactId>swagger2markup</artifactId>
    <version>1.3.3</version>
</dependency>

配置repositories

<repositories>
    <repository>
        <id>spring-libs-milestone</id>
        <url>https://repo.spring.io/libs-milestone</url>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
    </repository>
</repositories>

<pluginRepositories>
    <pluginRepository>
        <id>spring-plugins-release</id>
        <url>https://repo.spring.io/plugins-release</url>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
    </pluginRepository>
</pluginRepositories>

实现代码如下

调用Swagenerator之前需要先运行application主程序

public class SwagGenerator {
    //生成AsciiDocs格式文档
    public void generateAsciiDocs() throws Exception {
        Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
                .withMarkupLanguage(MarkupLanguage.ASCIIDOC)
                .withOutputLanguage(Language.ZH)
                .withPathsGroupedBy(GroupBy.TAGS)
                .withGeneratedExamples()
                .withoutInlineSchema()
                .build();

        Swagger2MarkupConverter.from(new URL("http://127.0.0.1:8080/v2/api-docs"))
                .withConfig(config)
                .build()
                .toFolder(Paths.get("./docs/asciidoc/generated"));
    }

    //生成Markdown格式文档
    public void generateMarkdownDocs() throws Exception {
        Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
                .withMarkupLanguage(MarkupLanguage.MARKDOWN)
                .withOutputLanguage(Language.ZH)
                .withPathsGroupedBy(GroupBy.TAGS)
                .withGeneratedExamples()
                .withoutInlineSchema()
                .build();

        Swagger2MarkupConverter.from(new URL("http://localhost:8080/v2/api-docs"))
                .withConfig(config)
                .build()
                .toFolder(Paths.get("./docs/markdown/generated"));
    }
    //生成Confluence格式文档
    public void generateConfluenceDocs() throws Exception {
        Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
                .withMarkupLanguage(MarkupLanguage.CONFLUENCE_MARKUP)
                .withOutputLanguage(Language.ZH)
                .withPathsGroupedBy(GroupBy.TAGS)
                .withGeneratedExamples()
                .withoutInlineSchema()
                .build();

        Swagger2MarkupConverter.from(new URL("http://localhost:8080/v2/api-docs"))
                .withConfig(config)
                .build()
                .toFolder(Paths.get("./docs/confluence/generated"));
    }

    //生成AsciiDocs格式的一个文档
    public void generateAsciiDocsToFile() throws Exception {
        Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
                .withMarkupLanguage(MarkupLanguage.ASCIIDOC)
                .withOutputLanguage(Language.ZH)
                .withPathsGroupedBy(GroupBy.TAGS)
                .withGeneratedExamples()
                .withoutInlineSchema()
                .build();

        Swagger2MarkupConverter.from(new URL("http://localhost:8080/v2/api-docs"))
                .withConfig(config)
                .build()
                .toFile(Paths.get("./docs/asciidoc/generated/all"));
    }

    //成Markdown格式的一个文档
    public void generateMarkdownDocsToFile() throws Exception {
        Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
                .withMarkupLanguage(MarkupLanguage.MARKDOWN)
                .withOutputLanguage(Language.ZH)
                .withPathsGroupedBy(GroupBy.TAGS)
                .withGeneratedExamples()
                .withoutInlineSchema()
                .build();

        Swagger2MarkupConverter.from(new URL("http://localhost:8080/v2/api-docs"))
                .withConfig(config)
                .build()
                .toFile(Paths.get("./docs/markdown/generated/all"));
    }
    public static void main(String[] args) throws Exception {
        SwagGenerator generator = new SwagGenerator();
        generator.generateMarkdownDocsToFile();
    }
}

导出结果

image-20201104165238001

markdown格式

image-20201104165327064

asciidoc格式

image-20201104170034876

参考链接

https://www.hellojava.com/a/59418.html
https://cloud.tencent.com/developer/article/1332445

不好意思海底捞月
关注
  • 0
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
SpringBoot整合Swagger2
06-18
SpringBoot整合Swagger2是将流行的微服务框架Spring Boot与API文档工具Swagger2相结合，以便于开发者创建、管理和展示RESTful API。Swagger2提供了一种直观的用户界面，使得API的使用者能够轻松地探索和理解接口的...
swagger2word.zip
08-24
标题“swagger2word.zip”暗示了这是一个关于将Swagger生成的JSON接口定义转换为Word文档的项目。Swagger，也称为OpenAPI Specification（OAS），是一种用于描述RESTful API的规范，它使用JSON格式来定义API的结构、...
swagger 常用注解
xiaolyuh的专栏
12-11 1254
swagger2 注解整体说明 用于controller类上： 注解 说明 @Api 对请求类的说明 用于方法上面（说明参数的含义）： 注解 说明 @ApiOperation 方法的说明 @ApiImplicitParams、@ApiImplicitParam 方法的参数的说明；@ApiImplicitParams 用于指定单个参数的说明 用于方法上面（返回参数或对象的说明）： 注解 说明 @ApiResponses、@ApiResponse 方法
四、Swagger2常用注解
付之一笑的专栏
05-15 1959
一、swagger2常用注解 1.1、Api @Api是类上注解。控制整个类生成接口信息的内容。 tags：类的名称。可以有多个值，多个值表示多个副本。 description：描述，已过时。 @RestController @RequestMapping(value = "/person") @Api(tags = {"PersonController","人员控制器"},description = "测试API类型描述信息") public class PersonController { 在swag
Swagger2注解详解
从入门到放弃的博客
02-15 690
https://www.jianshu.com/p/515e48e98152 https://www.jianshu.com/p/f30e0c646c63
常用swagger2注解的详解
moyanxiaoq的博客
11-15 558
简介： swagger2可以将项目的所有接口在一个UI界面上展示出来，同时表明了这个接口的用途，接口需要的参数是什么类型参数是否必须，输入了参数可以直接测试接口类似postman的功能，会显示接口请求的状态码和返回的数据结构。 优点： 大大减少前后端的沟通 方便查找和测试接口 提高团队的开发效率 方便新人了解项目 常用注解： swagger2是通过扫描很多的注解来获取数据帮我们展示在ui界面上...
swagger2 注解 详细使用说明
weixin_44972575的博客
07-18 2361
swagger2 注解说明一、maven依赖二、swagger2 注解整体说明三、swagger2 注解详细说明1.@Api：请求类的说明2.@ApiOperation：方法的说明3.@ApiImplicitParams、@ApiImplicitParam：方法参数的说明4.@ApiResponses、@ApiResponse：方法返回值的状态码说明5.@ApiModel：用于JavaBean上面，表示对JavaBean 的功能描述5.1、当请求数据描述时， `@RequestBody` 时的使用5.2、@
swagger2实例代码
09-22
Swagger2 是一个强大的工具，用于构建 RESTful 风格的 Web 服务API文档。它允许开发者通过注解在代码中直接定义API接口，生成交互式的API文档，从而简化了API的学习、测试和维护。Swagger2 被广泛应用于Spring Boot...
swagger2md.zip
04-06
Swagger2MD是一个实用工具，专为开发者设计，用于将Swagger JSON格式的API定义转换成Markdown文档。这个工具简化了API文档的创建过程，使得API接口的描述、参数和响应能够以Markdown这种易于阅读和编辑的格式呈现。...
SpringBoot2+Swagger2
02-18
标题中的"SpringBoot2+Swagger2"涉及到两个关键的Java开发框架：Spring Boot 2和Swagger 2。Spring Boot是Spring框架的一个子项目，旨在简化Spring应用的初始搭建以及开发过程，通过预设默认配置，使得开发者能够...
swagger2 注解说明
热门推荐
猎人在吃肉
11-28 11万+
swagger2 注解整体说明 @Api：用在请求的类上，表示对类的说明 tags=&amp;amp;amp;quot;说明该类的作用，可以在UI界面上看到的注解&amp;amp;amp;quot; value=&amp;amp;amp;quot;该参数没什么意义，在UI界面上也看到，所以不需要配置&amp;amp;amp;quot; @ApiOperation：用在请求的方法上，说明方法的用途、作用 value=&a
Swagger2常用注解说明
ThinkWon的博客
07-20 2万+
文章目录Swagger2简介使用Swagger解决的问题Spring Boot集成Swagger2添加依赖添加Swagger2Config配置类编写接口用户DTO用户controller访问接口文档Swagger2常用注解说明Controller相关注解@Api接口相关注解@ApiOperation@ApiParam@ApiImplicitParams@ApiImplicitParam@ApiResponses@ApiResponseModel相关注解@ApiModel@ApiModelProperty S
Swagger2常用注解解析（轻松构建Swagger）
莫安逸无风雪
05-06 1471
Swagger2常用注解解析一、SpringBoot集成Swagger2二、常用注解解析具体使用举例说明： 一、SpringBoot集成Swagger2 引入相关jar包 <!-- swagger2 配置 --> <dependency> <groupId>io.springfox</groupId> <artifactId...
swagger2常用注解剖析
董含的博客
05-19 153
1.@Api：请求类的说明 @Api：放在 请求的类上，与 @Controller 并列，说明类的作用，如用户模块，订单类等。 tags="说明该类的作用" value="该参数没什么意义，所以不需要配置" 示例： @Api(tags="订单模块") @Controller public class OrderController { } @Api其它属性配置： 属性名称 备注 value url的路径值 tags 如果设置这个值、value的值会被覆盖 .
swagger2 介绍+注解说明
最新发布
.
01-10 7553
swagger接口文档API优势: 1.支持 API 自动生成同步的在线文档：使用 Swagger 后可以直接通过代码生成文档，不再需要自己手动编写接口文档了，对程序员来说非常方便。 2.提供 Web 页面在线测试 API：有文档还不够，Swagger 生成的文档还支持在线测试。参数和格式都定好了，直接在界面上输入参数对应的值即可在线测试接口。
可变参数
weixin_52284319的博客
12-03 140
可变参数 在JDL1.5之后，如果我们定义一个方法，需要接收多个参数，并且多个参数的数据类型一致，那么我们可以简化成如下格式： 修饰符 返回值类型 方法名(参数类型... 形参名){ //... } 其实上面的格式，完全等价于下面的格式 修饰符 返回值类型 方法名(参数类型[] 参数名){ //... } ​ 只是后面的写法，在方法调用时，必须传递一个数组类型，而前者可以直接传递参数数据。 JDK1.5之后出现的简化操作。"…"用在参数上，我们称之为可变参数。 ​ 同样是代表数组，但是在
Swagger2 常用注解
weixin_45038601的博客
07-20 304
Swagger2 常用注解@Api@ApiIgnore@ApiOperation@ApiParam@ApiModel@ApiProperty@ApiImplicitParam@ApiImplicitParams@ApiResponse@ApiResponses@ApiError@RequestParam@PathVariable@Api、@ApiOperation、@ApiParam 、 @RequestParam演示代码 @Api @Api： 用于类，标识这个类是swagger的资源。 @ApiIgno
swagger 各个注解的作用（详解）
奋斗的哼哼
07-16 2449
swagger2 注解说明 @Api() 作用于类，表示这个类是swagger管理的资源 属性说明： tags--表示说明 value-- 同样时表示说明，可以使用tags替换 注:tags可以放多个值，多个值放在数组中 @Api(value="Api的 value 属性值说明",tags={"tags属性说明","tags可以使用数组"}) @ApiOperation() 作用于方法，表示一个http请求的操作 属性说明： value--方法描述 notes--内容提示 tags可以重新分组（视
api在线文档swagger常用的注解
qq_16334741的博客
03-03 3019
背景：最近做前后端分离开发，我负责后端接口提供，自然少不了api接口文档。选择了比较容易上手的swagger。 1.@Api(tags = "案例管理") 解释：这个注解用在Controller类上面,tags是接口模块的名称。 代码截图： 效果截图： 2、@ApiOperation(value = "查询案例管理列表",notes = "页码为必要参数，时间格式: 年-月-日") 解释：这个注解是接口方法上使用的，value是这个接口方法的功能描述，notes属性是强调的注..
SpringBoot整合Swagger2配置与使用教程
"本文将介绍如何在Spring Boot项目中整合Swagger2，以便实现API接口的文档化和测试。Swagger2是一个流行的开源框架，用于构建、文档化和测试RESTful API。通过与Spring Boot的集成，我们可以轻松地创建交互式的API...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值