test example json rest documentation

example - RESTful JSON API Documentation Generator



json api test (10)

Me pregunto si alguien tiene alguna experiencia o recomendaciones sobre herramientas que puedan usarse para generar páginas web que documenten y le permitan jugar con una API RESTful JSON. Estoy pensando en algo como la API de desarrollador de Github o la consola de API de Google .

Al mirar a mi alrededor, he encontrado swagger de Wordnik, que se ve bien. Pero me pregunto si hay algo más y la experiencia de la gente con estas herramientas. Gracias.

Estamos trabajando en MireDot que funciona para Java / Jax-rs. Una configuración inicial toma menos de 5 minutos. Una versión base muy capaz es gratis.

Me gusta Apiary . Todavía en flujo, pero luciendo bastante bien.

Mi recomendación sería no confiar demasiado en los generadores de [documento del código fuente]. Creo que el público del documento finalmente es humano y necesita mucho más de lo que los archivos generados por WADL y máquina pueden proporcionar. Para ayudar a las herramientas, debes invertir tiempo y esfuerzo para dominar las idosyncracies de una herramienta.

Además, existe un límite práctico real sobre cuánto se puede incluir dentro del código fuente de una API. La mera documentación de nombres y tipos de parámetros no será de mucha ayuda (y completa) y la adición de solicitud de muestra y respuesta dentro del código fuente se ve mal (aunque es información esencial para los usuarios finales). Otra razón puede ser simplemente estética.

Twitter también mantiene los documentos a mano y eso es mucho decir. En mi humilde opinión, la mejor opción sería mantener la documentación en un formato amigable para los humanos y generar HTML / PDF, etc. a partir de eso.

Plug desvergonzado

https://github.com/rjha/restdoc

Esto es solo un par de scripts PHP muy simples que leen API de archivos de definición YAML y generan HTML. Puede que no se adapte bien a la enorme API de EBay, pero para los simples requisitos de documentación de la API, este puede ser un camino por recorrer.

la pregunta es bastante antigua, pero creo que todavía es real. Conozco tres herramientas de diseño de API:

Personalmente, creo que esas herramientas son buenas para compartir documentos API entre miembros de equipos relativamente pequeños de desarrolladores, donde cada desarrollador conoce la mayoría de los detalles específicos para un proyecto en particular y, literalmente, solo necesita saber si es POST o PUT y cuáles son los nombres del resultado JSON fields.

Necesitábamos tener características de administración de contenido ricas y convenientes junto con material REST específico que produciría hermosos documentos en varios formatos, como html o pdf de una sola página. No pudimos encontrar un software decente, por lo que decidimos crear Speca.io

Por el momento está en alfa y es totalmente gratuito, pero estamos encantados de jugarlo y cualquier comentario será apreciado.

rest-tool es una herramienta de línea de comando simple escrita en JavaScript usando Node.js. Hace posible crear proyectos independientes que proporcionan documentación, emulación y pruebas automáticas de API RESTful.

Puede crear API en funcionamiento en un par de minutos que actúan como zona desmilitarizada entre los desarrolladores frontend y backend.

Genera la documentación, los casos de prueba e incluso la lógica simulada dinámica del lado del servidor basada en plantillas, por lo que todo es altamente personalizable.

Swagger podría ser para ti. Tiene implementaciones en varios idiomas.