Skip to content

Naming Conventions

Gabriel Jimenez edited this page Sep 20, 2021 · 5 revisions

Artifact Naming Convention:

Rule: When it comes to naming an artifact, the most common entries should be utilized first. The least amount of entries last per section.

4 sections that maintain the following order -

1) platform 2) type of module 3) communication method 4) business function/ resource

  • {platform name}-{type of module}-{communication method}-{business function / business resource}

Populated Examples:

  • bookstore-client-rest-book group - io.americanexpress.bookstore artifact name - client-rest-book

  • synapse-client-rest-book

Bookstore-

  • client

  • client-rest-book

With a preference to eliminate naming convention by the utilization of hierarchy. However, if doing so, the section should be inside the groupId.

Clone this wiki locally