what are the main checklist or points that we need to take care while designing API?

Question

MuleSoft Community Forum Member (Inactive) · Accepted Answer

Hi Friend, Good Questions... I hope below URL will help you to understand in details.   https://medium.com/hashmapinc/rest-good-practices-for-api-design-881439796dc9   Thanks, Rishi

Nidhi Prakash Srivastava · Answer

Hi  @achitanand001     The actual design will be based mainly on the requirement provided. From an overall design viewpoint:   1. Must be modular(each API should perform a single work).    Should have less dependence on other APIs or code of other APIs.   2. In scenarios where we need API led connectivity, major focus to be put on ensuring as less calls to other APIs as possible(more API calls mean more network calls which decrease performance).   3. Secure(strictly define) the input data like body payload(by defining schemas), parameters(provide default values, use enums, define type of string, maxLength, minlength, etc.), so you have more control on your API calls   4. Proper nesting of APIs resources(like a parent level can be employee, and child levels can be getEmployee, addEmployee, etc)   5. Allow for pagination of response records, security(using API manager) -- but this one is purely on requirement.   Design pointers are mainly on the requirement. These are some high level. If you want to know something specific please let me know.

what are the main checklist or points that we need to take care while designing API?

MuleSoft API Manager

Aprendizagem relacionada

Mais ajuda