97 cosas que todo programador Java debe saber

Capítulo 55. Hagamos un contrato: el arte de diseñar una API Java

Este trabajo se ha traducido utilizando IA. Agradecemos tus opiniones y comentarios: [e-mail]

Mario Fusco

Una API es lo que los desarrolladores utilizan para realizar alguna tarea. Más concretamente, establece un contrato entre ellos y los diseñadores del software, exponiendo sus servicios a través de esa API. En este sentido, todos somos diseñadores de API: nuestro software no funciona de forma aislada, sino que sólo resulta útil cuando interactúa con otro software escrito por otros desarrolladores. Al escribir software, no sólo somos consumidores, sino también proveedores de una o varias API, por lo que todo desarrollador debe conocer las características de las buenas API y cómo conseguirlas.

En primer lugar, una buena API debe ser fácilmente comprensible y descubrible. Debería ser posible empezar a utilizarla e, idealmente, aprender cómo funciona sin leer su documentación. Para ello, es importante utilizar nombres y convenciones coherentes. Esto parece bastante obvio; sin embargo, es fácil encontrar, incluso en la API estándar de Java, situaciones en las que no se ha seguido esta sugerencia. Por ejemplo, ya que puedes invocar a skip(n) para saltarte los n primeros elementos de un Flujo, ¿cuál podría ser un buen nombre para el método que se salta todos los elementos del Flujo hasta que uno ...