Spring REST Docs 正在参加 2021 年度 OSC 中国开源项目评选,请投票支持!
Spring REST Docs 在 2021 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
2021 年度 OSC 中国开源项目评选 正在火热进行中,快来投票支持你喜欢的开源项目!
2021 年度 OSC 中国开源项目评选 >>> 中场回顾
Spring REST Docs 获得 2021 年度 OSC 中国开源项目评选「最佳人气项目」 !
授权协议 Apache
开发语言 Java
操作系统 跨平台
软件类型 开源软件
开源组织
地区 不详
投 递 者 叶秀兰
适用人群 未知
收录时间 2015-06-26

软件简介

Spring REST Docs 帮助你管理 RESTful 服务文档,使用 Asciidoctor 来编写文档,使用 Spring MVC Test. 自动生成片段。

展开阅读全文

代码

评论 (6)

加载中
同问
2017/12/02 10:13
回复
举报
试用了一下1.1.3这个版本,应为这个版本支持spring 4,现在公司的项目也是基于spring4~! 优点:界面好看,可以培养写junit的习惯 缺点:学习成本和维护成本相比swagger来说,restDOC就像安卓手机,swagger就是苹果手机~! 总之,我们暂时不会选择它~!
2017/11/30 18:20
回复
举报
和swagger是类似东西么
2017/11/29 22:22
回复
举报
打分: 力荐
有人试用过吗?效果如何?
2017/07/24 13:57
回复
举报
自己玩了一下, 资料过少,需要自己熟练使用spring,才能跟上官方文档操作, 有点提升文档详细度,以及活跃度
2017/07/24 13:50
回复
举报
有人试用过吗?效果如何?
2016/12/23 10:47
回复
举报
更多评论
发表于大前端专区
2018/12/12 07:04

Spring REST Docs 1.2.6.RELEASE 与 2.0.3.RELEASE 发布

Spring REST Docs 1.2.6.RELEASE 与 2.0.3.RELEASE 发布了,Spring REST Docs 是 RESTful 服务的测试驱动文档,使用 Asciidoctor 手工编写内容结合使用 Spring MVC Test 框架自动生成示例,轻松编写 RESTful 服务文档,旨在成为易于阅读的用户指南,类似于 GitHub 的 API 文档,而不是像 Swagger 这样的工具生成的全自动、密集的 API 文档。 两个维护版本都带来了一些 bug 修复和文档改进。 发布公告 下载地址:https://github....

0
15
发表了资讯
2017/11/29 07:43

Spring REST Docs 2.0.0. 正式发布

Spring REST Docs 2.0.0. 发布了。Spring REST Docs 2.0 是项目的最新版本,要求 Java 8 和 Spring Framework 5.0。 主要亮点: 支持使用 Spring WebFlux 的 WebTestClient 来记录 API WebTestClient 可用于轻量级测试和 API 文档,它们使用 WebFlux Fn 和 WebFlux 的基于注释的编程模型实现 可以用来记录任何可以通过 HTTP 访问的 API(以前只有在使用 REST Docs 的 REST Assured 支持时才有可能。) 更多内容请查看发布说明。...

5
28
发表了资讯
2017/10/31 07:28

Spring REST Docs 2.0.0.RC1 发布

Spring REST Docs 2.0.0.RC1 发布了。Spring REST Docs 2.0 是项目的最新版本,要求 Java 8 和 Spring Framework 5.0。 主要亮点: 支持使用 Spring WebFlux 的 WebTestClient 记录 API。 WebTestClient 可用于使用 WebFlux Fn 和 WebFlux 基于注释的编程模型实现的 API 的轻量级测试和文档 可用于记录能通过 HTTP 访问的任何 API,但仅限于 API 在使用 REST 文档的 REST Assured 支持时 更多内容请查看发布说明。 下载地址: ...

3
19
发表了资讯
2017/05/13 07:26

Spring REST Docs 1.2.1,用于管理 RESTful 服务文档

Spring REST Docs 1.2.1 发布了,该维护版本包括一些错误修复和文档改进。推荐所有 Spring REST Docs 用户进行升级。具体如下: bug: Field snippets do not support XML payloads other than application/xml bug: RestDocsExtensionRegistry is included in main API documentation bug: Cookies are duplicated in curl, HTTPie, and HTTP request snippets with latest Spring Framework 5 snapshots documentation: Add m...

2
35
发表了资讯
2017/04/25 07:12

Spring REST Docs 1.2.0 和 1.1.3 发布

Spring REST Docs 1.2.0 和 1.1.3 发布了。 Spring REST Docs 1.2.0 值得关注的更新: 改进了 Asciidoctor 集成:REST Docs 现在有一个新的模块 spring-restdocs-asciidoctor,可以更容易地在文档中使用生成的片段。一个新的宏意味着可以在单行中为相同的操作导入多个片段。 更好地支持记录大型和复杂的有效载荷:为了让文档更容易使用,现在可以将大型和复杂的有效载荷的文档分解。有效载荷的分段可以单独记录,以便文档指导用...

4
25
发表了资讯
2016/09/01 00:00

Spring REST Docs 1.1.2 发布,bug修复

Spring REST Docs 1.1.2 发布了,Spring REST Docs 帮助你管理 RESTful 服务文档,使用 Asciidoctor 来编写文档,使用 Spring MVC Test. 自动生成片段。 该版本主要是修复一些bug,详情请查阅发布说明:http://spring.io/blog/2016/08/31/spring-rest-docs-1-1-2-release 下载地址: Source code (zip) Source code (tar.gz)...

3
32
发表了资讯
2016/06/01 00:00

Spring REST Docs 1.1.0 发布

Spring REST Docs 1.1.0 发布了,Spring REST Docs 帮助你管理 RESTful 服务文档,使用 Asciidoctor 来编写文档,使用 Spring MVC Test. 自动生成片段。 版本发布说明:http://spring.io/blog/2016/05/31/spring-rest-docs-1-1-0-release 下载地址: Source code (zip) Source code (tar.gz)...

8
57
发表了资讯
2015/12/11 00:00

Spring REST Docs 1.0.1 发布

Spring REST Docs 1.0.1 发布,这是个维护版本,有一些变更,包括提升对 XML payloads 记录属性的支持。 Project Page | GitHub | Issues | Documentation Spring REST Docs 帮助你管理 RESTful 服务文档,使用 Asciidoctor 来编写文档,使用 Spring MVC Test. 自动生成片段。

8
22
发表了资讯
2015/10/08 00:00

Spring REST Docs 1.0.0 发布

Spring REST Docs 1.0.0 发布,详情请看发行说明。下载页面:v1.0.0.RELEASE。 Spring REST Docs 帮助你管理 RESTful 服务文档,使用 Asciidoctor 来编写文档,使用 Spring MVC Test. 自动生成片段。

4
33
发表了资讯
2015/09/09 00:00

Spring REST Docs 1.0.0.RC1 发布

Spring REST Docs 1.0.0.RC1 发布,更新内容如下: Support for documenting path parameters Support for documenting multipart requests Support for documenting constraints declared using the Bean Validation API Improved extensibility Improved configurability, including template-based snippet rendering that allows you to take complete control over the generated snippets 详细信息请查看:发行说明。 Sp...

6
21
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
发表了博客
2018/02/01 09:59

Api管理工具(spring-rest-docs)

对于app开发来说,必须需要有相应的api文档,一般最基础的就是用markdown工具来撰写api文档。当对于开发人员来说,是总会想着寻找更方便撰写,测试,对接前端开发的文档生成的工具。 其实这方面的工具很多:手动撰写的也很多,很多都带有mock测试功能。方便前端对接时使用。 国内的也不少: RAP:动态生成模拟数据,实时测试等功能。 eoLinker:基于云端的api管理工具,同时提供在线协作,测试等的功能。 SBDoc:SBDoc是一个商业...

0
0
发表于服务端专区
2018/09/10 14:29

Spring Rest Docs WebTestClient自动生成接口文档Gradle版

文章同步在[个人博客](https://www.jgayb.cn/?p=197) **以前接口文档都是用swagger2在线文档,最近升级为spring boot2 + webflux反应式编程后,swagger2不支持webflux,无法使用,因此文档生成改为官方的spring rest docs,实践过程中因为英文不咋地走了一些弯路,在这里记录一下吧。** #### 1. 首先就是依赖和gradle插件 官方的gradle依赖,**要注意的地方是plugins的位置**。本文是markdown书写缺失一些asciidoc的显示 ```gro...

0
9
发表于开发技能专区
2020/01/27 11:53

Error Handling for REST with Spring

1. Overview This article will illustrate how to implement Exception Handling with Spring for a REST API. We'll also get a bit of historical overview and see which new options the different versions introduced. Before Spring 3.2, the two main approaches to handling exceptions in a Spring MVC application were: HandlerExceptionResolver or the @ExceptionHandler annotation. Both of these have some c...

0
0
发表了博客
2020/01/06 18:38

0106 springMVC REST风格

# markdown xx笔记语法练习带快捷键的 **加粗** 快捷键 cmd+b *斜体* cmd+i 分割线 cmd+u * * * 编号列表: cmd+shift+o 无编号列表 cmd+shift+u 待办事项 cmd+shift+T 代码块 cmd+shift+P 1. 编号列表项目1 2. 编号项目列表2 * 无编号列表项目1; * 无编号列表项目2; * [ ] 待办事项1 * [ ] 待办事项2 ```java System.out.println("hello world"); ``` # 背景 >rest是一种http协议的风格,在互联网时代这种风格在微服务中流行...

0
0
发表了博客
2018/09/25 19:45

SpringMVC视图及REST风格

点击进入第二章:SpringMVC基础配置 什么是视图解析器? springMVC用于处理视图最重要的两个接口是ViewResolver和View。 ViewResolver的主要作用是把一个逻辑上的视图名称解析成一个真的的视图,而SpringMVC中用于把View对象呈现给客户端的是View对象本身,而ViewResolver只是把逻辑视图名称解析为对象的View对象。 View接口的主要作用是用来处理视图,返给给客户端。 视图解析器的执行流程: 请求方法执行完成后,最终返回一个...

0
0
发表了博客
2019/07/10 15:09

spring rest小马哥

幂等 PUT 初始状态:0 修改状态:1 * N 最终状态:1 DELETE 初始状态:1 修改状态:0 * N 最终状态:0 非幂等 POST 初始状态:1 修改状态:1 + 1 =2 N次修改: 1+ N = N+1 最终状态:N+1 幂等/非幂等 依赖于服务端实现,这种方式是一种契约 #自描述消息 > Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8 第一优先顺序:text/html -> application/xhtml+xml -> application/x...

0
0
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
暂无内容
6 评论
92 收藏
分享
OSCHINA
登录后可查看更多优质内容
返回顶部
顶部