We recommend the following naming conventions as a starting point:


Hint: Use the 'rename' refactoring command (alt+shift+r on Windows) to rename elements. 

  • rapidModel (e.g. Experiments)
    • TitleCase
    • Plural - where the rapidModel name corresponds to a Subject Matter Area, e.g. Experiments, Facilities, etc.
  • resourceAPI
    • TitleCase
    • Singular
  • dataModel
    • TitleCase
    • Singular
  • Data Types (structure, enum, simpleType)
    • TitleCase
    • Singular
  • Properties
    • camelCase
    • Singular or plural, depending on cardinality
  • Constants (enum constants)
    • UPPER_UNDERSCORE
    • Singular or plural, as appropriate
  • Resources (objectResource, collectionResource)
    • TitleCase
    • Singular, with 'Object' or 'Collection' suffix
  • URI segments (e.g. /invoices/87234/lineItems/1
    • root data structure URI segment (e.g. invoices)
      • camelCase
      • plural
    • reference URI segment (e.g. lineItems)
      • camelCase
      • singular or plural, depending on reference property cardinality
  • Method, a.k.a. Operation names
    • camelCase
    • singular or plural, as appropriate (e.g. addEntry or addEntries, according to function)