Estos son algunos de los puntos que uno debe tener en cuenta al diseñar API:
- Mantenga el enfoque de diseño modular en el fondo de su mente. Naturalmente, esto lo llevará a crear tales API que proporcionarán una funcionalidad completa. Le ayudará a segregar varias funcionalidades en diferentes módulos y, por lo tanto, API.
- El consumidor de sus API puede ser cualquier cosa, pueden ser aplicaciones de Android o aplicaciones de escritorio o cualquier cosa. Apunte a mantener al cliente con un peso ligero.
- Los nombres de API son muy importantes. Los nombres deben explicarse por sí mismos y no deben confundirse con otros que proporcionan otro conjunto de características. Imagine que se le ha dado una lista de funciones y desea seleccionar cuál se ajusta a sus necesidades. Obviamente, buscará el nombre de la función y la documentación del siguiente paso.
- La documentación debe estar bien escrita (después del punto mencionado anteriormente, esto se leerá antes de la selección final).
- No haga que la lista de parámetros se pase como muy compleja.
- Utilice la estructura de datos adecuada para cada uno de los parámetros pasados.
- No haga que el consumidor continúe manejando excepciones indebidas.
- Y siga todas las reglas que se deben seguir en la programación orientada a objetos.
¡Feliz codificación!