API designs
Opened this issue · 0 comments
cszach commented
Before API are coded and implemented, it is essential that designs are sketched. Designs must document:
- Names of APIs
- Functions of APIs
- Parameters of APIs and their names
- Return values
The purpose of having API designs is to create consistency and avoid doing API revamps in the future, since API designs are quick sketches that get carefully reviewed before they are actually implemented using code.
API designs can be documented using Markdown and found in the wiki.