Naming Convention
Category | Sub Category | Pattern | Examples |
API Spec | RAML Spec Name | lower case, hyphen
{domain}-{subdomain}-{layer}-api |
students-sys-api
hackathon-ux-api |
API Spec | WSDL | lower case, hyphen
{name}-wsdl |
students-wsdl |
API Fragment | Data Type | lower case, hyphen
{domain}-data-type |
student-data-type
identity-data-type |
API Fragment | Security Scheme | lower case, hyphen
{layer}-security-scheme |
sys-security-scheme
prc-security-scheme |
API Fragment | Trait | lower case, hyphen
{name}-resource-type |
pageable-trait |
API Fragment | Resource Type | lower case, hyphen
{name}-resource-type |
get-resource-type |
API Fragment | Library | lower case, hyphen
{name}-lib |
payments-lib |
API Fragment | User Documentation | lower case, hyphen
{name}-doc |
naming-conventions-doc |
API Fragment | Example | lower case, hyphen
{method}-{name}-{request|response}-example |
get-accounts-response-example |
API Fragment | Annotation Type | {name}-annotation-type | custom-annotation-type |