Header Ads Widget

Ticker

6/recent/ticker-posts

Guía definitiva para más de 30 soluciones de documentación API


Supongamos que ha desarrollado una API web  y ahora quiere mostrársela al mundo. Luego viene la documentación, y adivinen qué, hay una herramienta para eso. Pero, en un mar de herramientas de generación de documentación API, ¿cuál es la adecuada para su entorno específico?

Esta lista completa de soluciones de documentación de API se ha seleccionado específicamente para proveedores de API web. Toman una fuente de API, idealmente en forma de definición de API , y la convierten en documentación agradable y presentable a la que los consumidores desarrolladores pueden consultar.

Antes de revisar cada uno a continuación, primero comprendamos los  lenguajes de definición de API (DL) con las comunidades más activas. Estos constituyen la mayoría de las herramientas disponibles para los proveedores de API:

  • Especificación de API abierta : derivada de Swagger de Smartbear , la API abierta se está convirtiendo en el estándar de la industria para la especificación de API. Basado en JSON, The Open API Initiative supervisa.
  • API Blueprint : un potente lenguaje de descripción de API de alto nivel para API web. API Blueprint es un formato de documento basado en Markdown que le permite escribir descripciones de API y documentación de una manera simple y directa. Desarrollado por Apiary.
  • RAML : RESTful API Modeling Language es una especificación de diseño legible por máquina que es amigable para los humanos. Basado en YAML, desarrollado por Mulesoft.
  • Documentos de E / S : los documentos de E / S son el formato de definición para las API creadas dentro de la red TIBCO Mashery. Define las API a nivel de recursos, métodos y parámetros en un esquema JSON. Definición más detallada aquí .

Otros lenguajes de definición de API notables incluyen: Google Discovery Format, WSDL, WADL, Rapid-ML , HAR, Postman Collection, APIMATIC Format, Mashape JSON Format, Hydra y otros . Las API definidas de esta manera son legibles por máquina, pero requieren un poco más de trabajo para crear una interfaz legible por humanos. Ahí es donde entran nuestras herramientas de documentación.

En esta publicación, hemos investigado software de código abierto como Swagger UI o Slate, software con licencia como Readme.io y referencias de API generadas dentro de suites de administración de API como 3scale. Todo podría usarse para generar HTML y CSS para mostrar métodos API, parámetros, valores, solicitudes, respuestas, ejemplos de código y más.

Algunos son portales de desarrolladores alojados, plantillas no alojadas o varían en sus conjuntos de funciones; por ejemplo, puede inclinarse por generar un centro de desarrolladores completo con Gelato, encontrar una suite de diseño para la colaboración como Postman Cloud útil o evitar los adornos con una plantilla de esqueleto como Carte.

Pero, ¿por qué confiar en otra dependencia para generar documentación? El ahorro de tiempo y costes es un buen argumento. Otro es el hecho de que estas organizaciones han estudiado a los maestros de la documentación de API de calidad como Stripe o Twilio, y han modelado sus diseños estáticos, comportamientos interactivos y exploradores de API, creando enfoques elegantes para describir gráficamente una API web. Como las API deben transmitir datos a través de tecnologías estándar, en aras de la incorporación de desarrolladores, la documentación de referencia coherente en toda la industria es una ventaja significativa.

¡Gracias a Ivan Goncharov de APIs.guru que proporcionó el conjunto de datos original que puso en marcha esta investigación!

1: interfaz de usuario Swagger

Visualice e interactúe con los recursos de la API
Swagger | Demostración en vivo de código abierto

Una opción de uso común es Swagger UI . Desarrollado por Smartbear, Swagger UI se genera automáticamente a partir de una especificación Swagger y permite a los desarrolladores interactuar con los recursos de una API. Dado que es de código abierto en Github , el proyecto se puede reformar, descargar y alojar en cualquier entorno. Los activos HTML, CSS y JavaScript del proyecto convertirán una especificación Swagger en una presentación legible por humanos, con una plantilla desplegable de página ancha que documenta cada método, parámetro y operaciones. Los desarrolladores que utilicen SwaggerHub para construir y diseñar su API encontrarán una solución de documentación sencilla incorporada . Swagger ha sido naturalmente bifurcado por muchos otros; para una implementación angularJS de Swagger UI, consulte angular-swagger-ui .

2: pizarra

Hermosa documentación estática para su API de
código abierto | Markdown | Demostración en vivo de Ruby

Desarrollado por Robert Lord mientras realizaba una pasantía en Tripit, Slate le ayuda a escribir documentación de API a mano utilizando Markdown. Slate ofrece una plantilla sencilla para ingresar sus métodos API, parámetros, descripciones y CSS personalizado. Inspirado en la documentación de Stripe limpia , Slate genera un diseño de tres columnas ; logotipo de la empresa con filtrado de métodos a la izquierda, descripción de la API en el medio y fragmentos de código a la derecha.

Este diseño intuitivo coloca todo en una sola página navegable con un desplazamiento suave. En el backend, todo está anotado en rebajas, incluso las muestras de código se escriben en bloques de rebajas. Slate también ofrece resaltado de sintaxis para más de 100 idiomas. De forma predeterminada, sus documentos de Slate están alojados en páginas de Github, por lo que puede tener alojamiento gratuito.

Una variedad impresionante de organizaciones utilizan Slate, incluidas NASA, IBM, Sony, Travis-CI, Best Buy y muchas otras. Para un tutorial, consulte este tutorial de Sitepoint sobre cómo escribir documentación de API con Slate.

Una documentación de API en blanco * pizarra *

Una documentación de API en blanco * pizarra *

3: colmenar

Blueprint for API Development
API Blueprint | Demostración en vivo de Swagger

Apiary.io es una pila de diseño que permite a los equipos diseñar, crear prototipos y documentar API. Apiary se considera la herramienta más importante para representar el lenguaje de descripción del modelo API , pero también es compatible con la especificación de API abierta. Miles de equipos usan Apiary para generar rápidamente el diseño clásico de tres niveles, con navegación a la izquierda, funcionalidad legible por humanos en el centro y fragmentos de código receptivos a la derecha. Cada acción tiene su propio enlace permanente.

Además de la documentación interactiva, la suite Apiary proporciona un editor de descripción, un servidor simulado, un depurador, un inspector de tráfico para monitorear el uso de la API y otras características incluidas en sus planes . Mucho viene gratis, pero necesitará una cuenta estándar para incrustar una referencia de API personalizada en su propio dominio.

Ejemplo de documentación de API de Apiary: API no oficial de Tesla

Ejemplo de documentación de API de Apiary: API no oficial de Tesla

4: Readme.io

Hermosas referencias de API de forma fácil.
Swagger  | Demostración en vivo de Markdown

Readme.io es un generador de documentación de software multipropósito que impulsa muchos centros de desarrollo de API. Viene con un editor basado en Markdown, soporte de versiones, un explorador de API para demostrar llamadas de muestra y funciones de crowdsource donde los usuarios pueden sugerir cambios de API.

Algo exclusivo de Readme.io es que proporcionan una plantilla para un portal completo para desarrolladores . Las páginas de inicio dedicadas del centro de desarrolladores son excelentes no solo para organizar volúmenes de referencia, sino que las páginas de inicio de API también ayudan al SEO y permiten compartir descripciones de alto nivel. Box, Yammer y Mozilla utilizan Readme.io para crear documentación para desarrolladores sencilla y eficaz.

5: helado

Genere portales para desarrolladores a partir de Swagger Specs
Swagger | Proyecto API | Demostración en vivo de Markdown

Desarrollado por Mashape como generador de documentación, Gelato.io también se puede utilizar para crear portales completos para desarrolladores. Gelato.io adopta un enfoque práctico similar; acepta cargas de Swagger o API Blueprint, y anota en Markdown con un editor de vista previa en vivo. El resultado final es un diseño agradable con un explorador de API interactivo y ejemplos de código. Brindan la capacidad de entregar documentos en un dominio personalizado con SSL y ofrecen funciones de administración adicionales con planes pagos. El explorador automático de API Gelato.io es bastante bueno; generada automáticamente a partir de la especificación de su API, la consola permite a los desarrolladores seleccionar un recurso y una acción de un menú desplegable, enviar solicitudes simuladas y ver respuestas en JSON.

Muelle de minutos del explorador de API de Gelatio.io

Base del explorador de API de Gelato

6: API-docs.io - Spotlight

Potencia tu estrategia de
API Especificación de OpenAPI (Swagger) | Demo en vivo de RAML

Stoplight.io convierte una especificación OAS o RAML en documentación legible por humanos con un formato agradable y la aloja de forma gratuita en API-docs.io . Para funciones adicionales de gestión del ciclo de vida de la API, Stoplight ofrece un diseñador de API, funciones de prueba de API, servicios web simulados y más dentro de sus planes de suscripción.

Con los Hosted Docs de Stoplight , los proveedores de API pueden generar un campo de API que cubre la autenticación básica y permite temas de documentación personalizados y dominios comerciales personalizados. Puede elegir entre un diseño grande o restringido para un enfoque de documento de pantalla completa o en columnas. Para cualquiera de los dos, la información estándar para las llamadas a la API está documentada y los visitantes de los desarrolladores pueden ver respuestas simuladas mediante un menú interactivo. Ofrecen varios temas, CSS personalizado y la capacidad de insertar un título, logotipo y favicon únicos para incluir la marca comercial. El resultado final es un diseño plano de gran apariencia con capacidades interactivas.

Los usuarios notables de Stoplight.io incluyen Sendgrid, Chargify, TiVo, vmware, entre otros. Vea más ejemplos de documentos para NPR , Peach y Giphy . Stoplight, una empresa de TechStars, come su propia comida para perros; su documentación de API interna se basa en su servicio de documentación.

7: ReDoc

Documentación de referencia de API generada por
OpenAPI / Swagger Demo en vivo de OpenAPI / Swagger 2.0

soporte de navegador solución ReDoc API

Buen navegador

ReDoc es una nueva solución de documentación API desarrollada por Rebilly. Este generador tiene un soporte integral de funciones de OpenAPI y produce un agradable menú de tres paneles que responde a dispositivos móviles y está diseñado para funcionar bien en todos los navegadores web.

Los encabezados de rebajas en la descripción de OpenAPI se utilizan en el menú lateral de introducción de la API y las muestras de código se pueden insertar a través de una extensión de terceros. Con la licencia del MIT, ReDoc podría tener el mismo impacto que un proveedor de documentos alojado, pero sin el costo. También tienen una opción Implementar en Github " para generar un repositorio Github con todas las funciones para su API.

En la demostración en vivo de la infame API Petstore , puede ver llamadas a métodos bien estructurados, parámetros interactivos y valores de respuesta. Los códigos de respuesta se indican claramente y los ejemplos de solicitud en JSON, C # y PHP se muestran en el extremo derecho. Para ver otro ejemplo de implementación, vea cómo APIs.guru , la floreciente Wikipedia de API, usa ReDoc para documentar su API de cara al público.

redoc-mobile-responsive-api-documentation

ReDoc ofrece un diseño de respuesta verdaderamente móvil

 

8: LucyBot

Ayuda a los proveedores de API a crear una experiencia de desarrollador perfecta
OpenAPI (Swagger) 2.0 | RAML | Proyecto API | WADL (usando la demostración en vivo del convertidor de especificaciones de API LucyBot

LucyBot tiene algunos trucos bajo la manga robótica. Con una impresionante variedad de soporte de lenguaje de definición de API, LucyBot API Portal creará documentación estática para métodos, parámetros y respuestas. Además de la documentación estática, LucyBot generará una consola API para realizar llamadas simuladas, así como recetas de guía para lenguajes de programación específicos. Los usuarios notables de Lucybot doc incluyen el New York Times y Kaltura .

9: Aglio

Un renderizador de API Blueprint con soporte de temas que genera HTML
API Blueprint | Demostración en vivo de Markdown

Aglio  es un renderizador API Blueprint de código abierto bajo licencia MIT. Lo que distingue a Aglio es su soporte para colores personalizados, plantillas y varios temas. Vea los temas Cyborg Two-Columned o Three-Columned para un diseño elegante y oscuro. Actualmente es compatible con el formato 1A de API Blueprint, con Aglio puede alojar el HTML resultante en cualquier servidor. Para obtener más información, consulte la publicación del blog de JetRuby que explica una implementación de Aglio.

Documento de la API del tema Aglio Cyborg

El tema oscuro "Cyborg" de Aglio se ve simplemente increíble

10: DESCANSO Unidos

API REST simplificada

REST United se especializa en generar y documentar SDK y código de muestra. Con él, puede enumerar fácilmente las variables estándar, describir operaciones, todo con un diseño receptivo para ver solicitudes, respuestas y códigos de error. REST United puede generar automáticamente SDK para 9 lenguajes de programación diferentes: ActionScript, Android, cURL, C #, Java, Objective-C, PHP, Python, Ruby y Scala.

Parece que el equipo de REST United también ofrece asesoramiento sobre diseño de API y asistencia con el código del lado del servidor. Los usuarios notables de REST United incluyen Uptime API y Hackernews .

11: Miredot

¡Miredot genera documentación de API REST directamente desde sus fuentes Java existentes! Demostración de
Java
Live

Miredot es una solución de referencia API diseñada para generarse continuamente en cada compilación. Con una supuesta configuración de 5 minutos, Miredot puede detectar API de ciertos marcos de Java para convertir el código Java en documentación. Los usuarios notables de Miredot incluyen APIman.io , Sophos , NUODB y otros.

12: Nube de cartero

Colección Postman de demostración en vivo

Postman es bien conocido por el botón "ejecutar" de la aplicación de Chrome que muchos desarrolladores utilizan para probar rápidamente las API públicas con un solo clic; esto se puede integrar con la documentación de su API, lo que le permite incorporar a los desarrolladores con capacidades de prueba más inmersivas. Cuando se trata de documentar colecciones de API, Postman Cloud actualizó recientemente su plataforma para permitir que los equipos publiquen documentación en URL de acceso público. La documentación de Postman Echo es un ejemplo de cómo se ve la documentación de la API de actualización automática. Postman Cloud también ofrece capacidades de prueba y diseño de API colaborativas, como crear y compartir colecciones de API, probar scripts, generar fragmentos de código y más. Los usuarios notables de Postman incluyen Boxy BestBuy. Consulte otras características de Postman Cloud aquí , o lea una revisión más detallada de Theodo . Para exportar y documentar las API de una colección de Postman, el postmanerador de código abierto también es una opción.

13: Apidox

Navegación y documentación de API interactivas en vivo para API RESTful.
XML | Demostración en vivo de PHP

Apidox es una herramienta de documentación basada en XML para API REST. Es interactivo, lo que permite a los desarrolladores probar las llamadas a la API desde la documentación. Parece ser una gran solución para crear rápidamente una API simulada para pruebas de desarrolladores. Apidox implementa su propio formato de definición único; sigue una estructura de mapa XML como se documenta en Github .

Documentación de API de muestra de Apidox

Apidox: recuerda a Apiary pero con estilo propio

14: API MINT

Demostración en vivo del
proyecto de API de API rápidamente prototipo

APIMINT es una herramienta de gestión del ciclo de vida de la API que es buena para crear rápidamente prototipos de API. Al usarlo, los desarrolladores que trabajan en varias plataformas pueden definir puntos finales rápidamente o usar datos simulados para ver rápidamente comportamientos de ejemplo. Para su documentación, parece que APIMINT usa Aglio, y luego lo condimenta con algo de CSS personalizado. La generación automática de documentos es una característica interesante; tendrás que descargarlos para alojarte tú mismo.

15: Documentos de E / S - TIBCO Mashery

Documentos de
E / S del sistema de documentación API interactiva | Demostración en vivo de JavaScript

TIBCO Mashery es un proveedor completo de gestión del ciclo de vida de API; naturalmente, brindan soluciones de documentación pública para sus clientes. Los portales API en Mashery Network proporcionan un medio para crear portales para desarrolladores y automatizar el proceso de registro y generar documentación interactiva.

Mashery Network también admite herramientas eléctricas API de código abierto Disponible en Github, I / O Docs es un "sistema de documentación interactivo para API web RESTful". I / O Docs es el enfoque de Mashery para definir capas de API base en un esquema JSON. I / O Docs generará una interfaz JavaScript que le permite ejecutar llamadas directamente desde la documentación de la API. El Explorador de API de Mashery se crea utilizando I / O Docs. A lo largo de los años, los usuarios notables de Mashery han incluido  Rotten Tomatoes y Klout .

Mashery TIBCO Sample I / O Docs de Klout

Documentos de E / S de muestra de Klout

16: SmartDocs - Apigee

Uso de SmartDocs para documentar API
WADL | Demostración en vivo de Swagger

Los usuarios de los servicios de administración de API de Apigee pueden usar Apigee SmartDocs para generar documentación completamente interactiva. Para Apigee, interactivo significa leer una descripción, enviar una solicitud en vivo y ver una respuesta en vivo. La consola Apigee permite esto; permitiendo a los desarrolladores filtrar por métodos, consultar ciertos parámetros o valores y realizar llamadas a la API. Con una plataforma de administración Edge, el portal de servicios para desarrolladores de Apigee aloja la documentación. Aunque las plantillas de SmartDocs tienen licencia de los clientes de Apigee, puede verlas en este repositorio de Github .

17: ActiveDocs - 3 escalas

Documentación de la API en vivo
Swagger
Live Demo

3scale ActiveDocs es una oferta dentro del kit de herramientas de administración de API de Red Hat 3Scale. Con una especificación Swagger, 3scale generará documentación interactiva que se sirve y se aloja en el portal para desarrolladores de 3scale de un proveedor. 3scale extiende Swagger ligeramente, agregando autocompletado de claves API, agrupando operaciones por colores y admitiendo tipos de datos complejos como hash, matrices y tipos personalizados.

18: Consola de API RAML - Mulesoft

Un componente web para una consola REST interactiva basada en archivos
RAML RAML | Demostración en vivo de NodeJS

Usando RAML Console , los proveedores de API pueden mostrar una definición de API RAML usando HTML en un navegador y métodos de prueba. Se puede implementar directamente o mediante un iframe. Anypoint Platform de Mulesoft también ofrece un portal para desarrolladores, capacidades de integración y los medios para diseñar y colaborar en los diseños de API, implementar y publicar documentación. La documentación crea una pantalla de dos columnas con métodos expandibles, que permiten pruebas en vivo con credenciales de usuario.

Documentos del portal de la API de Mulesoft

Documentos de referencia de Mulesoft Sample RAML

19: ASP.NET ApiExplorer - Microsoft

Creación de páginas de ayuda para ASP.NET Web API
C # | .NET | Tutorial XML

ASP.NET APIExplorer es una clase que permite a los desarrolladores que trabajan con el marco de la API web ASP.NET crear documentación estática de sus métodos HTTP y URI. ASP.NET Web API es un marco para crear API sobre el marco .NET; si trabaja en C #  esta es la herramienta para usted.

El paquete ASP.NET Web Tools tiene funciones integradas para generar automáticamente documentación de API. Esto genera una columna izquierda que enumera el método API y la interfaz de usuario relativa, así como una columna central que describe cada función, y existe la capacidad de crear estilos y diseños personalizados.

El Administrador de paquetes NuGet puede agregar páginas de ayuda a una API web existente escrita en C # o VisualBasic. Los comentarios de documentación XML se utilizan para describir métodos y parámetros. Construido dentro de la aplicación de escritorio de Microsoft, el menú permite que esto ocurra en la parte superior de la clase ApiExplorer ; parte del marco de la API web. ApiExplorer trata cada método como su propia API. Para comenzar, descargue la actualización de ASP and Web Tools 2012.2 aquí , o lea esta publicación sobre Creación de páginas de ayuda de API con ASP.NET para obtener más información.

20: Speca.io

Plataforma de documentación centrada en API web
Swagger | WADL

Speca.io , todavía en Beta, parece ser un competidor en el mercado de documentación de API web. Inspirado en documentos como Twitter o Stripe, Speca ofrece una documentación API navegable y fácil de usar y una consola API integrada. El Editor le permite definir encabezados de API, parámetros, mantener diferentes versiones de la API y exportar a Postman o Swagger. Mientras Speca.io todavía está en versión beta, puede navegar por los documentos de API que se han agregado aquí .

Documentación de la API de Speca Marvel

Documentos de la API pública de Marvel v1 con Speca

21: Restlet

Documentación de API mejorada
Swagger | RAML

Restlet proporciona una plataforma para entregar API fácilmente. Un  anuncio reciente  señaló que Restlet Studio, la herramienta de diseño de API, ahora proporciona documentación alojada, incluida la creación automática de documentos para las definiciones de API de Swagger y RAML. Para obtener más información, consulte la guía del usuario de Restlet sobre cómo crear  documentación de API .

Documentación de la API de Restlet

Ejemplo de documentación de la API de Restlet

22: RepreZen

Diseñe, documente y entregue API de clase mundial en un banco de trabajo completamente integrado
Swagger-OpenAPI 2.0 | RAPID-ML

Reprezen API Studio proporciona un IDE completo para la gestión colaborativa del ciclo de vida de la API. Construido alrededor de la especificación OpenAPI, Reprezen ofrece generación de documentación en vivo a medida que edita. Podría ser ideal para proyectos más grandes, ya que le permite dividir una especificación Swagger en varios archivos. Como la salida de RepreZen está basada en Bootstrap, la personalización es infinita con máscaras de Bootstrap y CSS personalizado. Además, el diagrama RepreZen es un enfoque novedoso para representar gráficamente la estructura y la jerarquía de API que se ajusta al lenguaje de modelado de API de RAPID-ML .

23: Carta

Sitio de documentación simple basado en Jekyll para API.
Jekyll | Demostración en vivo de YAML

Inspirado por Swagger y I / O Docs, Carte es una base de código abierto para crear su propia documentación API. Carte ofrece una forma más sencilla de describir las API, centrándose en objetos JSON y produciendo una plantilla de documentos básica construida con Jekyll de Github , el generador de sitios estáticos.

Plantilla de documentación de Carte API

Plantilla simplista de documentación de API Carte

24: tabla de snowboard

Analizador y renderizador de
planos de API Demostración en directo de planos de API

Snowboard es otro renderizador de planos API de código abierto. Bajo la licencia MIT, Snowboard puede generar documentación HTML y servir a través de HTTP. Tiene un colorido tema predeterminado para ilustrar los tipos de solicitud de API y el contenido de respuesta.

25: raml2html

Generador de documentación RAML a HTML.
RAML | Demostración en vivo de NodeJS

raml2html es un proyecto en Github de Kevin Renskers que podría actuar como una alternativa a RAML Console. Los menús desplegables ilustran las funciones de los parámetros y las cajas de luz muestran más detalles de las solicitudes. Con un diseño simple de dos columnas y resaltado de color para diferentes llamadas HTTP, raml2html es una solución de documentación funcional y simple para autohospedar una referencia RAML.

26: Leer los documentos

Cree, aloje y explore la documentación.
Demo en vivo

Read the Docs es una popular plantilla de documentación de software multipropósito que podría usarse para documentar las API RESTful. La generación automática de documentación de API utilizando Read the Docs no es posible por sí sola; Como solución alternativa, este desarrollador usa sphinx-apidoc para generar automáticamente la documentación y enviar archivos a un repositorio de Github para que Read the Docs pueda convertirlo en HTML.

27: Dexy.it

hacer | docs |
Python sexy | Agnóstico

Dexy.it es igualmente una herramienta de documentación de propósito general escrita en Python que algunos desarrolladores usan para documentar sus API. Los archivos de configuración de Dexy actúan como filtros que escanean archivos para realizar funciones basadas en tipos de archivos. Independiente del idioma, Dexy proporciona una forma de método estandarizado para referirse a áreas en su proyecto. Junto con otro software de código abierto, escribe expresiones que actúan como filtros para detectar partes de su contenido que se volverán a mostrar en otro documento.

"Los filtros de Dexy hacen cosas como ejecutar su código y hacerlo bonito, pero también pueden hacer casi cualquier otra cosa, como publicar sus documentos en un blog o wiki, o recuperar datos de una API".

28: apiDoc

Documentación en línea para API web RESTful
Demostración en vivo de NodeJS

apiDoc produce documentación API usando anotaciones dentro de su código. ApiDoc actúa como un analizador, detectando parámetros apiDoc dentro de comentarios como @apiDefine descripciones de métodos o, @apiExamplepor ejemplo, usos de un método API. Usando estas señales, apiDoc genera una documentación API limpia de dos columnas con tipo de llamada, parámetros, respuestas de error y otros requisitos estándar.

Vea una muestra en vivo de APIDOC aquí

Vea una muestra en vivo de APIDOC aquí

29: Pizarra

Simplemente escriba una hermosa documentación de API.
Código abierto | Markdown | Demostración en vivo de NodeJS

La pizarra comenzó como una bifurcación de pizarra. Como Slate está basado en Ruby, Whiteboard está escrito en NodeJS, lo que permite un proceso de configuración aparentemente más fácil. La documentación de Whiteboard parece idéntica a la de Slate, pero atraerá más a los usuarios de JavaScript que buscan una “instalación npm” y un “inicio npm” intuitivos.

30: ¡Documento! X - Innovasys

La documentación del servicio web REST simplificada
WSDL | Swagger | DESCANSO | SOAP | Demostración de Java
Live

¡ Documento de Innovasys X puede tomar descripciones de una API Swagger o WSDL y producir documentación estática, así como un árbol de datos que ilustra visualmente la jerarquía de datos. El resultado final es una documentación básica de dos columnas que organiza las llamadas en descripción, parámetros, respuestas y respuestas de error. ¡Documento! X se ve bien para documentar servicios web SOAP / XML.

31: Mercado de Mashape

Mashape JSON Format
Cloud API Marketplace donde los desarrolladores pueden consumir fácilmente la demostración en vivo de las API de Cloud

Cualquier proveedor de API puede optar por incluir su API de forma gratuita en Mashape Marketplace . Hacerlo generará documentación básica de la API. Para hacerlo, defina sus mecanismos de autenticación y agregue manualmente puntos finales de API utilizando su interfaz de usuario. Las funciones de administración de API de Mashape parecen apuntar a pequeños proyectos secundarios de API, ofreciendo capacidades plug and play para crear un portal para desarrolladores. Ofrecen un buen tutorial del proceso de documentación aquí . Mashape también diseñó APIembed para incrustar fragmentos de código.

32: Enganche

Hitch hq es un mercado para API donde los proveedores pueden enumerar sus servicios, aprovechar las funciones de administración de API y mantener un portal de desarrolladores de cara al público. También se puede utilizar para realizar un seguimiento de los cambios en cientos de API en toda la industria.

Hitch generará automáticamente documentación a partir de un archivo Swagger o RAML, y ayudan a las empresas a crear documentación legible por máquina si aún no la tienen. Los centros de desarrollo de API en Hitch pueden incluir la referencia de API, SDK, guías prácticas, un registro de cambios y más. La documentación de Hitch presenta un menú interactivo simple para hacer referencia a llamadas y descubrir parámetros y respuestas, como se muestra a continuación.

Ejemplo de API de Slack de documentación de Hitch

Ejemplo de API de Slack de documentación de Hitch

33: DapperDox

Hermosa e integrada documentación de OpenAPI Especificación
Swagger /  OpenAPI  | Demostración en vivo de código abierto

DapperDox es un generador de código abierto para documentar las API de OpenAPI. Un elemento único de DapperDox es que, además de crear documentación, genera guías y diagramas, lo que le permite escribir esto en un Markdown con sabor a Github. Otras características incluyen un explorador de API, personalización de temas y la capacidad de documentar múltiples servicios.

DapperDox es un generador de documentos de código abierto para las API de especificaciones de OpenAPI

34:  APITree

Cree, administre y comparta documentación
de API Autogeneración a partir de la demostración en vivo de la especificación OpenAPI v2 / v3

Con APITree puede convertir su especificación OpenAPI v2 / v3 en una hermosa documentación técnica de API. Las API públicas se alojan de forma gratuita en APITree HUB . Las API internas se pueden mantener privadas y compartir con los clientes directamente.

Otros

  • Haga clic en Ayuda

¿Tienes otros en mente? ¡Comenta abajo!

 

Publicar un comentario

0 Comentarios