API naming conventions

[pvdbosch]

In GitLab by @pvdbosch on Nov 14, 2019, 16:21

We haven't got any naming conventions for API names yet, except lowerCamelCase and may consist of multiple segments.

• recommend clear descriptive functional names rather than technical names ("gateway", "proxy") or project/brand names
• Singular noun describing domain that the API covers? ** e.g. /archiving ; but sometimes domain corresponds with the main resource type e.g. "/person" ** discourage terms applicable to most APIs if they aren't needed to distinguish from other APIs? "register"/"registry"/"repository" suffix, "management", ...?
• segments can be used to group APIs (domain/subdomain)

[pvdbosch]

rest guide currently says about "apiName":

Name of the API that groups a functional consistent set of resources. The API name consists of one or multiple path segments written in lowerCamelCase (example: /referenceData/geography).