Having gone through in detail of various design guidelines in preceding sections, let's do a quick recap of the best practices as applicable to each of the key focus areas:
| Focus area |
Best practices |
| Resource |
- Expose only those resources that are required for implementing the business use case
- Naming of resource must be nouns; avoid using verbs
- Avoid using generic name for resources, rather be specific
- Resource names may include hyphens; avoid using underscores and other punctuation
- Limit the length of the resource URI not to exceed 2,000 characters
- Child resource must limit the scope to respective parent
|
| Resource representation |
- Specify the content type supported by consumers of the API
- Avoid using multiple content ...
|