详解如何用spring Restdocs创建API文档

更新时间：2017年05月11日 11:07:47 作者：方志朋

这篇文章将带你了解如何用spring官方推荐的restdoc去生成api文档。具有一定的参考价值，感兴趣的小伙伴们可以参考一下

这篇文章将带你了解如何用spring官方推荐的restdoc去生成api文档。本文创建一个简单的springboot工程，将http接口通过Api文档暴露出来。只需要通过 JUnit单元测试和Spring的MockMVC就可以生成文档。

准备工作

你需要15min
Jdk 1.8
maven 3.0+
idea

创建工程

引入依赖，其pom文件：

<dependencies>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-test</artifactId>
      <scope>test</scope>
    </dependency>

    <dependency>
      <groupId>org.springframework.restdocs</groupId>
      <artifactId>spring-restdocs-mockmvc</artifactId>
      <scope>test</scope>
    </dependency>
  </dependencies>

通过@SpringBootApplication,开启springboot

@SpringBootApplication
public class Application {

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

在springboot通常创建一个controller:

@RestController
public class HomeController {

  @GetMapping("/")
  public Map<String, Object> greeting() {
    return Collections.singletonMap("message", "Hello World");
  }

}

启动工程，访问localhost:8080，浏览器显示：

{“message”:”Hello World”}

证明接口已经写好了，但是如何通过restdoc生存api文档呢

Restdoc,通过单元测试生成api文档

restdocs是通过单元测试生存snippets文件，然后snippets根据插件生成htm文档的。

建一个单元测试类：

@RunWith(SpringRunner.class)
@WebMvcTest(HomeController.class)
@AutoConfigureRestDocs(outputDir = "target/snippets")
public class WebLayerTest {

  @Autowired
  private MockMvc mockMvc;

  @Test
  public void shouldReturnDefaultMessage() throws Exception {
    this.mockMvc.perform(get("/")).andDo(print()).andExpect(status().isOk())
        .andExpect(content().string(containsString("Hello World")))
        .andDo(document("home"));
  }
}

其中，@ AutoConfigureRestDocs注解开启了生成snippets文件，并指定了存放位置。

启动单元测试，测试通过，你会发现在target文件下生成了一个snippets文件夹，其目录结构如下：

└── target
  └── snippets
    └── home
      └── httpie-request.adoc
      └── curl-request.adoc
      └── http-request.adoc
      └── http-response.adoc

默认情况下，snippets是Asciidoctor格式的文件，包括request和reponse，另外其他两种httpie和curl两种流行的命令行的http请求模式。

到目前为止，只生成了Snippets文件，需要用Snippets文件生成文档。

怎么用Snippets

创建一个新文件src/main/asciidoc/index.adoc ：

用 Spring REST Docs 构建文档

This is an example output for a service running at http://localhost:8080:

.request
include::{snippets}/home/http-request.adoc[]

.response
include::{snippets}/home/http-response.adoc[]

这个例子非常简单，通过单元测试和一些简单的配置就能够得到api文档了。

adoc的书写格式，参考:http://docs.spring.io/spring-restdocs/docs/current/reference/html5/，这里不多讲解。

需要使用asciidoctor-maven-plugin插件，在其pom文件加上：

<plugin>
  <groupId>org.asciidoctor</groupId>
  <artifactId>asciidoctor-maven-plugin</artifactId>
  <executions>
    <execution>
      <id>generate-docs</id>
      <phase>prepare-package</phase>
      <goals>
        <goal>process-asciidoc</goal>
      </goals>
      <configuration>
        <sourceDocumentName>index.adoc</sourceDocumentName>
        <backend>html</backend>
        <attributes>
          <snippets>${project.build.directory}/snippets</snippets>
        </attributes>
      </configuration>
    </execution>
  </executions>
</plugin>

这时只需要通过mvnw package命令就可以生成文档了。

在/target/generated-docs下有个index.html，打开这个html,显示如下，界面还算简洁：

结语

通过单元测试，生存adoc文件，再用adoc文件生存html，只需要简单的几步就可以生成一个api文档的html文件，这个html文件你可以通网站发布出去。整个过程很简单，对代码无任何影响。

源码下载：https://github.com/forezp/SpringBootLearning

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。

SpringBoot的监控及使用详解
这篇文章主要介绍了SpringBoot的监控及使用详解,Spring Boot提供了一系列的监控功能，方便开发人员对应用程序进行监控和管理,本文将讨论 Spring Boot中的监控功能及其使用方法,需要的朋友可以参考下
2023-07-07
详解在spring boot中消息推送系统设计与实现
这篇文章主要介绍了详解在spring boot中消息推送系统设计与实现，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2019-05-05
简单讲解Java的Future编程模式
这篇文章主要介绍了Java的Future编程模式,包括对异步和并发的一些设计思维,需要的朋友可以参考下
2015-11-11
Mybatis三种批量插入数据的方式
这篇文章主要介绍了Mybatis的三种批量插入方式，帮助大家更好的理解和学习使用Java，感兴趣的朋友可以了解下
2021-04-04
Java使用C3P0数据源链接数据库
这篇文章主要为大家详细介绍了Java使用C3P0数据源链接数据库，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2019-08-08
java 多线程的几种实现方法总结
这篇文章主要介绍了java 多线程的几种实现方法总结的相关资料,希望通过本文能帮助到大家，让大家掌握java多线程的知识，需要的朋友可以参考下
2017-10-10
SpringBoot-JPA删除不成功,只执行了查询语句问题
这篇文章主要介绍了SpringBoot-JPA删除不成功,只执行了查询语句问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-12-12
关于springboot中nacos动态路由的配置
这篇文章主要介绍了springboot中nacos动态路由的配置方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-09-09
JDK8中的HashMap初始化和扩容机制详解
这篇文章主要介绍了JDK8中的HashMap初始化和扩容机制，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-06-06
SpringBoot 插件化开发模式详细总结
插件化开发模式正在很多编程语言或技术框架中得以广泛的应用实践，大大提升了系统的扩展性和伸缩性，也拓展了系统整体的使用价值，那么为什么要使用插件呢，本文就详细介绍SpringBoot 插件化开发模式，感兴趣的同学可以参考下
2023-06-06