Herramienta para documentacion de API desde el fuente

VictorEspinaS

VictorEspinaS

Capo
Se incorporó
21 Marzo 2022
Mensajes
149
Hola cabros. Estoy buscando una utilidad que permita generar documentacion de API REST directo desde el fuente, al estilo de herramientas como PHP Documentor o JSDoc, es decir, que el programador pueda, directamente en su codigo fuente PHP (Laravel) poner un bloque de comentario con una cierta sintaxis y que luego la herramienta sea capaz de leer el codigo fuente, extraer la info de ese bloque de codigo y con eso generar una documentacion de ese API REST.

YA he evaluado otras herramientas como Swagger o APIary, pero en esas se requiere que el programador cree la documentacion fuera de su codigo fuente.

Alguna idea? existe algun software asi ?

Gracias de antemano
 
Sort by date Sort by votes
alex_xp

alex_xp

Gold Member
Se incorporó
12 Octubre 2004
Mensajes
2.616
Pero eso va a depender de que lenguaje este escrito el microservicio, si está en java, golang, etc. Ahí necesitas una herramienta específico por ejemplo javadoc.
Swagger es solamente para documentar el contrato y los recursos del api
 
Upvote 0
VictorEspinaS

VictorEspinaS

Capo
Se incorporó
21 Marzo 2022
Mensajes
149
alex_xp dijo:
Pero eso va a depender de que lenguaje este escrito el microservicio, si está en java, golang, etc. Ahí necesitas una herramienta específico por ejemplo javadoc.
Swagger es solamente para documentar el contrato y los recursos del api
Haz clic para expandir...
El webservice esta hecho con PHP y Laravel.
 
Upvote 0
leshowski

leshowski

Retamos City
Se incorporó
31 Enero 2006
Mensajes
1.213
Upvote 0
M

mario2130

Miembro Regular
Se incorporó
22 Junio 2023
Mensajes
31
Sin duda swagger es una excelente herramienta para documentar y aún más para crear api sólo a partir del schema que se puede conseguir. Si duda seguiría invirtiendo tiempo en esta herramienta
 
Upvote 0
D

dwlh

Miembro Activo
Se incorporó
4 Noviembre 2019
Mensajes
29
Lo que dicen ahí, OpenAPI, desde el fuente generas un archivo con la especificación, como dice cliobrando
cliobrando dijo:
Mis recomendaciones:
scribe.knuckles.wtf

Introduction | Scribe

Scribe helps you generate API documentation for humans from your Laravel/Lumen/Dingo codebase. See a live example at demo.scribe.knuckles.wtf.
scribe.knuckles.wtf scribe.knuckles.wtf
github.com

GitHub - ApiGen/ApiGen: PHP 7.1 ready Smart and Simple Documentation for your PHP project

PHP 7.1 ready Smart and Simple Documentation for your PHP project - ApiGen/ApiGen
github.com github.com
Haz clic para expandir...

Ahí puedes ver algo como swagger-ui o redoc, y por si eso fuera poco, puedes crear código de cliente (para usarlo directamente como si fuese un sdk en otros lados), como bien indica leswhoski
leshowski dijo:
github.com

GitHub - OpenAPITools/openapi-generator: OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)

OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3) - OpenAPITools/openapi-gener...
github.com github.com
Haz clic para expandir...

Entonces, código -> generacion de OpenApi spec -> generación de documentación y/o sdk
 
Upvote 0
M

mario2130

Miembro Regular
Se incorporó
22 Junio 2023
Mensajes
31
Yo que recuerde con swagger documentas dentro del código por lo menos en .net. Luego era re fácil compartir el contrato con empresas terceras para que lo implementasen

 
Upvote 0
You must log in or register to reply here.
Subir