新教E区

 楼主| 发表于 2019-1-24 10:31:52 | 显示全部楼层 |阅读模式
这篇文章将带你了解如何用spring官方推荐的restdoc去生成api文档。本文创建一个简单的springboot工程,将http接口通过Api文档暴露出来。只需要通过 JUnit单元测试和Spring的MockMVC就可以生成文档。
准备工作
  • 你需要15min
  • Jdk 1.8
  • maven 3.0+
  • idea
创建工程
引入依赖,其pom文件:
[url=][/url]
<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>[url=][/url]

通过@SpringBootApplication,开启springboot
[url=][/url]
@SpringBootApplicationpublic class Application {    public static void main(String[] args) {        SpringApplication.run(Application.class, args);    }}[url=][/url]

在springboot通常创建一个controller:
[url=][/url]
@RestControllerpublic class HomeController {    @GetMapping("/")    public Map<String, Object> greeting() {        return Collections.singletonMap("message", "Hello World");    }}[url=][/url]

启动工程,访问localhost:8080,浏览器显示:
{“message”:”Hello World”}
证明接口已经写好了,但是如何通过restdoc生存api文档呢
Restdoc,通过单元测试生成api文档
restdocs是通过单元测试生存snippets文件,然后snippets根据插件生成htm文档的。
建一个单元测试类:
[url=][/url]
@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"));    }}[url=][/url]

其中,@ AutoConfigureRestDocs注解开启了生成snippets文件,并指定了存放位置。
启动单元测试,测试通过,你会发现在target文件下生成了一个snippets文件夹,其目录结构如下:
[url=][/url]
└── target    └── snippets        └── home            └── httpie-request.adoc            └── curl-request.adoc            └── http-request.adoc            └── http-response.adoc[url=][/url]

默认情况下,snippets是Asciidoctor格式的文件,包括request和reponse,另外其他两种httpie和curl两种流行的命令行的http请求模式。
到目前为止,只生成了Snippets文件,需要用Snippets文件生成文档。
 架构代码如下:
Spring Cloud大型企业分布式微服务云构建的B2B2C电子商务平台源码请加企鹅求求:一零三八七七四六二六

回复

使用道具 举报

您需要登录后才可以回帖 登录 | 注册

本版积分规则

QQ|小黑屋|手机版|Archiver|新教e区 ( 鲁ICP备16007390号-1 )

GMT+8, 2019-2-19 08:39 , Processed in 0.062500 second(s), 18 queries , Gzip On.

新教E区

© 2006-2014 新教E区

快速回复 返回顶部 返回列表