Question

我目前正在考虑如何为我的应用程序构建REST API文档，并支持多种语言。端点，参数名称和返回值应保持不变，但我希望以不同的受支持语言提供每种REST方法的描述。

我正在使用Spring boot，data＆amp;休息并发现这个docs项目对我来说似乎非常有用。无论如何，我无法在文档中找到关于i18n主题/支持的任何信息。

有人知道Spring REST文档是否支持为多种语言生成API文档（一般情况下）？

Answer 1

REST Docs不为I18N提供任何开箱即用的支持，但在顶部构建内容应该非常简单。

REST Docs所涉及的主要部分以及我认为您想要翻译的内容是各种代码段中包含的描述。您可以在ResourceBundle：

中查找每个描述，而不是对特定描述进行硬编码

ResourceBundle resourceBundle = ResourceBundle.getBundle("field-descriptions");

mockMvc.perform(get("/").accept(MediaType.APPLICATION_JSON))
    .andExpect(status().isOk())
    .andDo(document("example", responseFields(
        fieldWithPath("a").description(resourceBundle.getString("a")),
        fieldWithPath("a.b").description(resourceBundle.getString("a.b")))));

Spring Rest docs - i18n支持

1 个答案: