API Design

Conciseness: When designing an API, you should minimize the set of methods, requests, objects, and resources exposed by the API. Unnecessary complexity makes the API difficult to understand and maintain.

Consistency: The object hierarchy and queries should be logically related and intuitive to API users. The names of objects and methods should correspond to their purpose. Names for the same objects and parameters must be consistent across all API methods.

Extensibility: API design should always consider the potential need for additional call parameters or object fields. It is often better to extend existing endpoints than to create new ones, which can complicate the API.