Frühling Rest docs Objekt verschachtelt

Question

Wir brauchen eine Antwort auf einen Anruf in der folgenden Form liefern:

{ 
    "3" : { 
    "id" : "3", 
    "parent" : "1", 
    "title" : "Folder 2", 
    "folder" : true 
    }, 
    "4" : { 
    "id" : "4", 
    "parent" : "2", 
    "title" : "Folder 1.1", 
    "folder" : true 
    }, 
    "doc:3" : { 
    "parent" : "3", 
    "title" : "Document 3", 
    "folder" : false 
    }, 
    "doc:2" : { 
    "parent" : "2", 
    "title" : "Document 2", 
    "folder" : false 
    }, 
    "doc:1" : { 
    "parent" : "3", 
    "title" : "Document 1", 
    "folder" : false 
    } 
} 

Wie soll ich es dokumentieren? Das Problem ist, dass das Objekt eine Struktur mit EntryId als Schlüssel ist und keine ID enthält, wenn es ein Dokument ist. Gibt es eine Option, wo ich Variablen verwenden kann, um Schlüssel zu definieren? Oder was empfiehlt sich für responseFields?

Answer 1

hatte ich das gleiche Problem, dass Andy Wilkinson in den Kommentaren zeigt und statt hard es in der ascii.doc, ich habe es in etwa so:

,relaxedResponseFields(
    fieldWithPath("key").description(getMessage(MessageProperties.TRANSLATION_RESOURCE_MAP_KEY)).type(MessageProperties.TYPE_STRING).optional(), 
    fieldWithPath("value").description(getMessage(MessageProperties.TRANSLATION_RESOURCE_MAP_KEY_VALUE)).type(MessageProperties.TYPE_MAP).optional(), 
    fieldWithPath("value[].key").description(getMessage(MessageProperties.TRANSLATION_RESOURCE_MAP_KEY_VALUE_KEY)).type(MessageProperties.TYPE_LONG).optional(), 
    fieldWithPath("value[].value").description(getMessage(MessageProperties.TRANSLATION_RESOURCE_MAP_KEY_VALUE_KEY_VALUE)).type(MessageProperties.TYPE_STRING).optional() 
) 

Scheck How to document response fields for an object as Map(HashMap) für weitere Informationen des Problems und wenn es dir wirklich gefällt.