I am developing an API for a company. They have multiple projects lined up to interact with the API.
The API will be sent an id of an object to disable. If this is successful the user who's item was disabled should receive an email.
My question is this: should the API be responsible for sending the email or should the API return that the object was disabled and the email address to send the email to?
Many thanks, looking forward to your opinions.
分享 As usual, I'd say it depends. Since the requirement of sending an email is directly in scope of the API and the API doesn't do much else, I don't see why it shouldn't send it. However, I would consider certain levels of configuration.
You could provide a function which simply returns the email address (or use a flag) and one function which does the whole thing (this should be configurable as well, e.g. set smtp server, email body text etc.). If you were to incorporate the email functionality, providing a simple function/method which only does the object manipulation comes cheap.
NB: In any case I'd try to resolve this requirement ambiguity with the company/customer before starting to develop. It could save you development work.
分享
