Buenas prácticas en el desarrollo de la API de JavaScript

Question

¿Cuál es un buen enfoque para diseñar una API de JavaScript?

Soy relativamente nuevo en JavaScript y conozco las principales características del lenguaje, principalmente de "JavaScript: The Good Parts". Actualmente, estoy diseñando una herramienta basada en web para enseñar estadísticas. La base del código se está volviendo difícil en parte porque no entiendo cómo diseñar una API de JavaScript.

Mi experiencia es en Java y C++ y estoy acostumbrado a diseñar interfaces y luego implementar esas interfaces de forma independiente. Obviamente, esto no funciona bien en JavaScript.

Gracias por cualquier ayuda y sugerencias.

actualización: Versión final de la herramienta aquí: http://www.lock5stat.com/statkey/index.html

Answer 1

En mi opinión, si está utilizando jQuery, la mejor solución es dividir su aplicación en complementos jQuery y widgets UI. Los complementos son una gran manera de organizar el código, puede reutilizarlos en otras aplicaciones y también puede liberarlos por separado.

Puede escribir sus aplicaciones como un árbol de complementos. Puedes pensar en complementos como clases en C++/Java con agregación pero no herencia.

Notas sobre el código: en función MAIN.bootstrapPlot que utiliza document.createElement, se debe utilizar jQuery como en el resto del código, y se les Canto library de lienzo.

Answer 2

Creo que es el mismo que el desarrollo de cualquier API, independientemente del idioma, teniendo en cuenta las características del lenguaje.

1. Como usted señala interfaces no tienen mucho sentido en javascript, pero es orientado a objetos, por lo que puede dividir su funcionalidad en 'clases', el uso de patrones de diseño, etc.

2. Documentación . Puede documentar una "clase" de JavaScript tal como lo hace con cualquier API.

3. Aunque no hay soporte nativo para interfaces o clases abstractas en js, aún puede aplicar los principios. Por ejemplo, puede crear una 'clase abstracta' definiendo un objeto con métodos que arrojen errores, de ese modo las subclases generarán un error si no se implementan correctamente. Cualquier cosa que use una interfaz puede hacer una simple comprobación para ver si los métodos necesarios están en su lugar en init. Tenga en cuenta que algunas personas js fruncirán el ceño al respecto, señalando que js es poco tipeado y dinámico, y debe utilizarse de esa manera.

Tenga en cuenta que puedo poner la 'clase' entre comillas porque Javascript no tiene noción como tal. La otra cosa que puede hacer es buscar API existentes como Sencha o jQuery para obtener algunas ideas. Sencha se siente como una API a la que un desarrollador del lado del servidor estaría acostumbrado (mire sus documentos).

Answer 3

John Resig has a scathing critique of the NodeIterator API. Aunque es una revisión de una API específica, proporciona algunas ideas (al menos lo que él cree) para una buena herramienta.