Allow descriptors to be loaded from a file

Overview

Starting discussion on Gitter

Would be great to be able to externalize documentation message outside of testing class like .properties or .yml files.

Moreover external resources could be localized to allow publish documentation in multiple language:

message.properties
message_fr_FR.properties
message_zh_CN.properties
...

Furthermore link between external resources and testing parameters should be automatic. We must use convention filename/path convention to be able to link each together.

Details

There are many points to take care:

• Which external resources format will be supported? (properties, yml)
• How to avoid collisions?
• An external resource per document identifier?
• Flat file and prefix (document identifier)?
• How can I manage placeholder?

key = blabla blabla forbidden values are {0}

• How to describe message type: STRING or whatever
• Ability to load external resource outside of Classpath

[wilkinsona]

Ignoring the shorthand for only specifying a description for the moment, I think the YAML could be improved:

field1:
  description: The description of field 1
field2:
  type: String
  description: The description of field 2
  attributes:
    constraints: Not null
    remarks: Lorem ipsem

The equivalent properties would be:

field1.description = The description of field 1
field2.type = String
field2.description = The description of field 2
field2.attributes.constraints = Not null
field2.attributes.remarks = Lorem ipsem

[patrice-conil]

As we also use swagger, i’ve made a maven plugin that generate FieldDescriptors from model classes. You should find this here: restdoc-helper