使用Rest Doc通过版本控制来记录Rest API

时间:2018-05-03 07:52:42

标签: rest versioning spring-restdocs

我正在使用Rest Doc来记录我的Rest API。基于TestNg方法,我生成了片段,稍后我会在asciidoc中使用它。

例如,我有一个休息端点来检索人员,还有一个TestNg方法来记录它。那么,我可以在我的ascii doc中使用它:

=== Get People

Get the people registered.

operation::get-people[snippets='http-request,request-fields,http-response,response-fields,error-codes']

但是现在,我的API发生了变化,我引入了版本控制,因此API与版本1不同。我也想要正确记录,但我不知道如何做到这一点"较少侵入性"可能的。

我希望我的文档具有此结构

资源   V1     getPeople   V2     getPeople

对于真正从一个版本更改为另一个版本的API,我需要为api支持生成每个版本的不同代码段,因为请求字段或响应字段可能不同。

但是,我还有一些其他的端点,从一个版本到另一个版本具有相同的API,我认为我还需要为每个版本生成片段,因为该版本是其余端点路径的一部分。

您是否知道如何将版本添加到其余文档?

0 个答案:

没有答案