spring-boot - Spring Rest 文档 - i18n 支持

Question

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

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

有人知道 Spring REST 文档是否支持生成多种语言的 API 文档（通常）？

Answer 1

REST Docs 没有为 I18N 提供任何开箱即用的支持，但在上面构建一些东西应该很简单。

涉及 REST Docs 并且我认为您想要翻译的主要部分是各种片段中包含的描述。而不是硬编码一个特定的描述，你可以在 a 中查找每一个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")))));