Simplicity is crucial in design, particularly in API design.
Keep the KISS principle in mind - "Keep It Simple, Stupid." ✅
▶️ Use standard, concrete, and shared terms familiar to most people.
▶️ Allow application developers to perform tasks in only one way, avoiding confusion from multiple options. (simplicityyyy)
▶️ Design the API with the client's (application developers) needs in mind.
▶️ Focus on the major use cases for the API first, and address exceptional cases later.
For example, using the GET, POST, PATCH requests listed below, someone using the API should easily use them without having to refer to documentation or understand specialized terms:
POST /login
GET /profile
POST /register
POST /profile
PATCH /profile
And they should be able to do so consistently, without having to remember multiple methods or options for each type of data. 🎉🎉
For better understanding HTTP verbs, this mdn doc is a great resource
