Dash, Zeal y DevDocs: así puedes organizar tu repositorio de APIs

4 min lectura
Dash, Zeal y DevDocs: así puedes organizar tu repositorio de APIs
Dash, Zeal y DevDocs: así puedes organizar tu repositorio de APIs

BBVA API Market

El mundo del desarrollo del software va subido en un Ferrari por una autopista alemana. Cada vez son más los lenguajes de programación, marcos de desarrollo, intérpretes por el lado del servidor, bases de datos y APIs que es necesario manejar para lanzar proyectos competitivos. En torno a esta gran explosión, nacen nuevas herramientas vinculadas a gestión y productividad. Un ejemplo perfecto de ello son los organizadores de interfaces de programación de aplicaciones.

Hoy en día existen dentro del mercado varios organizadores de APIs, documentación técnica de sintaxis y frameworks y librerías o bibliotecas de todo tipo. Los tres principales son Dash, Zeal y DevDocs. Son posiblemente las tres soluciones más utilizadas por la comunidad de desarrolladores. Y tienen la ventaja de que eso les ayuda a evolucionar la herramienta de forma rápida y eficiente.

Dash: acceso a más de 150 APIs

Dash es una herramienta para iOS y OSX que permite a los desarrolladores navegar por documentación técnica de más de 150 APIs. Este organizador dispone de la documentación offline, cada usuario escoge qué información quiere descargar y Dash lo hace. Existe la posibilidad de que el desarrollador pueda crear sus propios documentos de información técnica o solicitar documentación de terceros.

En estos momentos, Dash dispone de información técnica de todo el universo Apple (iOS, OSX, watchOS y TVOS), JavaScript (AngularJS, Ember.js, Express.js, Node.js, jQuery, jQuery UI, jQuery Mobile, Knockout.js, MongoDB, D3.js…), PHP (CakePHP, symfony, Zend Framework…), Django, Java, Microsoft .NET, CMS como WordPress o Drupal… El listado completo de soluciones es espectacular.

Dash también permite su integración en gestores de paquetes de terceros para solicitar y descargar toda la documentación especial que sea necesaria para un proyecto: paquetes de Ruby (Ruby Gems), Scala, Java, C, C++, C#, Objective-C, Python, JavaScript, HTML, Dart, Go o PHP. Además, es posible descargar documentación de la página para desarrolladores Stack Overflow. La creación de docsets permite compartirlos con otros usuarios mediante una URL personalizada.

Una característica interesante de Dash, al margen de la búsqueda y descarga de documentación técnica, es la gestión de fragmentos de código en el organizador. Dentro de esta funcionalidad, destacan algunas ventajas muy útiles en desarrollo:

– Almacenamiento y reutilización de fragmentos de código.

– Etiquetado de esos fragmentos para su clasificación y ordenación.

– Resaltado de sintaxis.

En junio de 2015, Dash lanzó la tercera versión (Dash 3) para el sistema operativo Mac OSX, la última y mayor actualización por ahora. Algunos de los cambios fundamentales e incorporaciones en Dash 3 son peticiones de usuarios:

– Menos uso del espacio en disco gracias a un nuevo sistema de archivo de la documentación técnica: solo se descuelgan cuando se van a utilizar. Los creadores de Dash estiman que el uso de espacio se reduce diez veces.

– Restauración automática de pestañas: la herramienta lanza la sesión de trabajo en el mismo punto en la que se dejó la última vez.

– Sincronización de la configuración a través del Mac, incluyendo documentación técnica ya instalada, perfiles de búsqueda y favoritos.

– Apertura de páginas en local o en internet.

– Servidor de anotaciones de código abierto y configurable: los desarrolladores podrán hacer anotaciones con comentarios o ejemplos y establecer si esas anotaciones son sólo privadas o totalmente públicas.

Zeal: un Dash para Linux y Windows

Es un navegador offline de documentación técnica inspirado en Dash, pero para sistemas operativos Linux y Windows. Zeal aprovecha, por tanto, el espacio dejado por su competidor fuera del entorno de Apple. La idea de Zeal es que los equipos de desarrollo siempre puedan tener a mano la documentación de sus APIs o APIs de terceros, sin obligación de estar conectados a la Red y con la integración de su editores de texto como VIM, Sublime Text, Emacs o KTextEditor o entornos de desarrollo integrado (IDEs) como IntelliJ IDEA mediante el uso de plugins:

– Plugin para la integración de Sublime Text. La instalación de los paquetes para la integración de editores o IDEs se puede hacer mediante el control de paquetes, con Git (la conocida herramienta de control de versiones usando el comando git clone https://github.com/vaanwd/Zeal) o bien de forma manual (descargar el paquete de Zeal de su sitio en GitHub, descomprimir el archivo .zip y copiar la carpeta en el directorio de Sublime Text).

– Plugin para Emacs.

– Plugin para VIM.

Además, Zeal dispone de algunas otras características también muy interesantes:

– Generar documentación técnica propia.

– Herramienta libre y de código abierto.

– Soporta documentación de todo tipo, muy similar a Dash: lenguajes de programación como JavaScript, Java, Ruby, Python, C, C++, C#, PHP, Dart, Go, .NET, Scala o HTML… y dentro de esas sintaxis soluciones como AngularJS, BackBoneJS, EmberJS, KnockoutJS, Bootstrap, CakePHP, Laravel, MongoDB, Ruby on Rails, symfony, Drupal, WordPress, Xamarin, jQuery… En total más de 198 grupos de documentación técnica de infinidad de plataformas.

Zeal es bastante sencillo de instalar. En el caso de disponer de sistema operativo Ubuntu, el usuario lo único que debe hacer es ejecutar estos tres códigos:

$ sudo add-apt-repository ppa:zeal-developers/ppa
$ sudo apt-get udpate
$ sudo apt-get install zeal

Para instalarlo en Windows, descargar el instalador, ejecutarlo y seguir los pasos.

DevDocs, navegador offline con extensión para Chrome

 

DevDocs es otro navegador de documentación técnica de distintos lenguajes de programación, herramientas de desarrollo de software y APIs. Su creador es Thibaut Courouble, desarrollador del equipo actual de Shopify (creador de negocios online) y de CSSFlow, una de las páginas más interesantes de widgets libres en HTML5, CSS3 y Sass para el desarrollo front-end de interfaces de usuario.

Algunas de las características que definen a DevDocs son:

– Navegador offline de APIs: no es necesario estar conectado a internet.

– Dispone de una extensión para conectarse con Chrome.

– Es gratuito y de código abierto.

– Plugins de integración para editores como Sublime Text, Atom o Brackets.

Más información sobre APIs aquí.

Síguenos en @BBVAAPIMarket

También podría interesarte