怎么用Swagger自动生成REST API帮助文档?-问答-阿里云开发者社区-阿里云

开发者社区> 问答> 正文

怎么用Swagger自动生成REST API帮助文档?

1358896759097293 2021-05-01 11:53:33 44

怎么用Swagger自动生成REST API帮助文档?

API 网络架构
分享到
取消 提交回答
全部回答(1)
  • 1358896759097293
    2021-05-02 23:44:58

    25.png

    官网 https://swagger.io Swagger自动化文档工具

    1. Swagger是一个完整的API生态,工具,规范,代码生成。
    1. 用于描述,生成,使用和可视化RESTful Web服务。
    2. Swagger API project 2011 Tony Tam创立 最早Java版。
    3. SmartBear Software公司支持,Apache License 2.0。
    4. OpenAPI Spec。
    5. Swagger and OAS。
    6. Swagger 2 to OpenAPI 3。
    7. 捐赠给linux基金会。
    8. 行业标准规范。
    9. Swagger Tools一套工具:设计、开发、测试、监控、治理。

    25.1.png

    Spring REST Docs

    1. Spring REST Docs帮助自动化生成RESTful服务的文档。
    1. 使用Asciidoctor编写的手写文档
    2. Spring REST Docs为RESTful服务生成准确且可读的文档。
    3. 将手写文档与使用Spring测试生成的文档片段相结合。
    4. 不受Swagger等工具生成的文档的限制。
    5. 它可以生成准确,简洁和结构良好的API文档。
    6. Spring REST Docs支持测试驱动Test Driven。
    7. Spring REST Docs支持Spring MVC Test框架,Spring WebFlux的 WebTestClient或REST Assured 3测试驱动。
    8. Spring Boot 提供了注解@AutoConfigureRestDocs
    9. 替代SpringFox Swagger

    优点

    1. 手写文档与使用Spring Test框架生成的文档片段结合。
    1. curl and http request snippets are generated。
    2. easy to package documentation in projects jar file。
    3. easy to add extra information to the snippets。
    4. supports both JSON and XML。

    MockMvc

    1. MockMvc是Spring MVC Test工具类,支持Assert和Chain。
    1. @Mock创建模拟对象,Mock。
    2. @InjectMocks会自动将mock依赖注入测试对象。
    3. MockitoAnnotations.initMocks(this)初始化。
    4. MockMvcBuilders.standaloneSetup(..).build()通过注册一个或多 个@Controller实例并以编程方式配置Spring MVC基础结构来构建 MockMvc实例。
    5. @Test 标注测试方法。
    6. @WebMvcTest注解用于Spring MVC测试。 它禁用完全自动配置,而只应用与MVC测试相关的配置。
    7. WebMvcTest注解也自动配置MockMvc实例。

    Asciidoctor插件步骤

    1. pom.xml添加Asciidoctor插件
    1. 添加对spring-restdocs-mockmvc的依赖
    2. 配置属性asciidocs输出位置sourceDirectory
    3. 配置测试任务task输出位置outputDirectory
    4. 配置asciidoctor task
    5. snippets定义snippets输出位置
    6. 使task依赖于test任务,以便在创建文档之前运行测试
    7. 将snippets配置为输入。将在此目录下创建所有代码段

    REST Assured

    1. Rest-Assured 由 Java 实现的 REST API 测试框架
    1. 在Java中测试和验证REST服务比在Ruby和Groovy等动态语言中更难。
    2. REST Assured简化REST API测试。
    3. 专为测试 REST API 而设计的 DSL
    4. Java DSL,用于轻松测试REST服务
    5. REST Assured支持任何HTTP方法,但明确支持POST,GET,PUT,DELETE, OPTIONS,PATCH和HEAD,并包括指定和验证例如 parameters, headers, cookies body 。
    6. 自动化测试
    7. http://rest-assured.io/

    Spring Auto Rest Docs Spring REST Docs 最低要求

    1. Java 8
    1. Spring Framework 5 (5.0.2 or later)
    2. 此外, the spring-restdocs-restassured要求 :
    3. REST Assured 3.0

    Spring Rest Docs Demo Spring Rest Docs实战

    25.2.png

    Asciidocs Maven Plugins

    25.3.png

    25.4.png

    Spring REST Docs可以在线方便的调试自己的API,但是没有 Swagger 使用方便,这边就简单介绍下,重点还是讲实战Swagger。 Spring Boot 2.0 实战Swagger

    25.5.png 引用Swagger的包,需要自己做一些参数化的配置,简单的可以在配置文件进行,复杂一些配置需要在代码里面进行。生成的调试方式也比较简单,生成的网页里面在详细的检索描述性,可以在线的发送get、Post等经典请求格式,很方便的去调接口,对于前后端分离的架构来说是很方便。

    页面打开两种方式: http://localhost:8081/swagger-ui.html

    1. /v2/api-docs
    1. Swagger UI /swagger-ui.html

    接口文档的版本可以不断的变化,也可以在后台进行配置

    Swagger-core 注解 25.6.png

    在开发过程中,默认的话什么都不加的话,实际解析的信息如说控制器或者类别的基本信息。如果希望对内加一些描述信息。对原接口加原表述信息的话,可以加进来如传输的数据类型,加个model的 API model加个说明,模组里面字段你可以加property这个说明。操作具体方法的话可以operation,参数的话有pyramid的说明,应答消息和请求消息的话也可以加 response,这种相对的这些注解说明都可以了。它会自动的把这些信息提取出来,生成放到Swagger在线帮助文档里。

    Spring Boot 2.0 Rest API注解

    25.7.png 应答消息401、404、403等消息可以自己定制,如整合API的类型的话,可以加入淘宝用户的API接口等,根据自己的需求进行添加。

    接口也可以分类,目前是这里简单做了几个分类:订单接口,用户接口,并可以在里面进行测试,方便在线检查,并视图形式,反馈各个消息类型的结果。 测试有错注意点: 需要使用RestController,不要是用Controller 出现order repository 问题,是没有数据的原因 Swagger功能非常强大,也方便调试开发,尤其是前后端分离的架构。

    0 0
开发与运维
使用钉钉扫一扫加入圈子
+ 订阅

集结各类场景实战经验,助你开发运维畅行无忧

推荐文章
相似问题
推荐课程