2017-03-22 14 views
0

現在、私のアプリケーション用に複数の言語をサポートするREST APIドキュメントを構築する方法を考えています。エンドポイント、パラメータ名、戻り値は同じである必要がありますが、別のサポートされている言語で提供したい各RESTメソッドの説明を保持してください。Spring Rest docs - i18n support

私は春のブートを使用して、データ&休憩し、このドキュメントプロジェクトは私にとって非常に役に立つと思われるものを見つけました。とにかく、i18nトピック/サポートに関して、ドキュメント内の情報を見つけることができませんでした。

Spring RESTドキュメントが複数の言語(一般的に)のAPIドキュメントの生成をサポートするかどうかは誰にも分かりますか?

答えて

2

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"))))); 
+0

非常に良い解決策 – rajadilipkolli

関連する問題