如何使用swagger进行多人协同开发

电脑:联想笔记本、系统Windows10

Spring Tool Suite 4

方式/步调

  1. 1

    引入swagger依靠,如下图所示。

    8601a18b87d6277ff4589a5127381f30e924fc15.jpg
  2. 2

    在启动类的同级目次下建立Swagger2类,作为设置装备摆设类,如下图所示。

    ★经由过程@Configuration标识表记标帜此类为设置装备摆设类,会在SpringBoot项目启动的时辰加载,@EnableSwagger2用来启动Swagger。
    ★Swagger会主动扫描我们设置装备摆设的cn.com.wenyi.controller包下的接口主动生当作接口文档。

    8644ebf81a4c510f78814a736f59252dd42aa516.jpg
  3. 3

    在Controller类上利用@Api注解,如下图所示。

    c9fcc3cec3fdfc038d6248d1db3f8794a4c22644.jpg
  4. 4

    在方式上利用@ApiOperation注解来给API增添方式申明,如下图所示。

    024f78f0f736afc3322c940cbc19ebc4b74512b2.jpg
  5. 5

    在方式上利用@ApiImplicitParams或者@ApiImplicitParam注解,用来给方式入参增添申明,如下图所示。

    79f0f736afc3793147bb2e40e4c4b74542a91183.jpg eac4b74543a982269dc3804e8582b9014a90eb5d.jpg
  6. 6

    在实体类上利用@ApiModel注解,描述一个Model的信息,如下图所示。

    5ab5c9ea15ce36d37962285935f33a87e950b171.jpg
  7. 7

    在实体类的属于变量上利用@ApiModelProperty,描述一个model的属性,如下图所示。

    37d12f2eb9389b5099e84a3b8a35e5dde7116e40.jpg
  8. 8

    启动Spring Boot程序,拜候:http://localhost:8080/swagger-ui.html,看看显示结果,如下图所示。

    38dbb6fd5266d01639fb3541982bd40734fa35fc.jpg
  9. 9

    总结:

    1、引入swagger依靠

    2、建立Swagger2类,利用@Configuration与@EnableSwagger2

    3、利用@Api

    4、利用@ApiOperation

    5、利用@ApiImplicitParams或者@ApiImplicitParam

    6、利用@ApiModel

    7、利用@ApiModelProperty

    8、拜候:http://localhost:8080/swagger-ui.html

  • 发表于 2019-12-19 17:00
  • 阅读 ( 967 )
  • 分类:其他类型

你可能感兴趣的文章

相关问题

0 条评论

请先 登录 后评论
联系我们:uytrv@hotmail.com 问答工具