Hello je suis en train de fabriquer une API REST pour une solution, et j'aimerai pouvoir créer une documentation de cette API
Exemple : /getCustomers | return an array of customers or false

Spécificités :
J'aimerai pouvoir exporter cette documentation en verstion HTML pour un site web et en version markdown, voire sur github directement.

Connaissez-vous un tool sympa qui permette d'éditer une doc d'API et de faire ça rapidement ? :)

5 réponses


TransientDev
Réponse acceptée

Salut,

Pour un projet à la fac j'avais utilisé apiary. La syntaxt pour la doc est du yaml il me semble. Tu peux voir le résultat ici.

@TransientDev : Résultat très sympa dans l'architecture de l'info et dans le design. Free pour de la doc publique. En revanche le 1er prix de l'outil fait un peu réfléchir... 99$/mois, ouch.

Swagger.Io me semble pas trop mal, beaucoup plus laid mais fonctionnel :)

j'utilise ca moi, ca convient a mon utilité personnelle mais a voir ;) (désolé le post était déjà résolus)

Bonjour,
Sinon il existe Swagger. C'est utilisé dans la plupart des entreprises, ce n'est pas du markdown mais du Yaml si mes souvenirs sont bon. Cependant il existe de nombreux plugins pour être brancher sur des frameworks/langages et qui permettent de génerer la doc automatiquement :
Par exemple :
PhP
HapiJS

Il en existe plusieurs, si tu es interessé je te laisse regarder.

je ne suis pas l'auteur du post mais merci @Makino, ca a l'air super ;)