Produire et publier des Rubis REST Api documentation

Quels sont cool kids aujourd'hui d'analyser facilement/générer/publier des Api REST? J'ai pris un coup d'oeil sur Swagger et Il a l'air sympa, mais de mon point de vue, il ne rentre pas ok avec Ruby. Peut-être que je suis juste mauvais et je suis en manque de quelque chose, de l'aide serait appréciée.

  • Me semble excellent, mais il semble aussi ne demandent beaucoup de travail pour l'installation
  • Exactement, c'est génial, mais il a une tonne de dépendances que j'aimerais éviter.
InformationsquelleAutor jpemberthy | 2012-04-23
  1. 15

    Des sons que vous n'avez pas une API encore? Si c'est le cas, c'est l'approche que je recommande.

    • Créer un interface de l'API à l'aide de la swagger-spécification. Vous pouvez le faire sans l'aide d'un serveur, voir ici.

    • Vérifier l'interface en utilisant swagger-ui. Cela vous permet de voir tous les paramètres que vous avez définis (et encore, aucun codage, sauf pour les fichiers json!)

    • Une fois que vous avez une interface que vous souhaitez, utilisez swagger-codegen de construire une extraite de la version de votre serveur. Il y a actuellement des modèles pour nodejs et scalatra avec plus sur le chemin. Faire un nouveau serveur générateur est simplement une question de la création/modification de certaines moustache modèles.

    • Vous pouvez également générer votre client avec swagger-codegen.

    La beauté de ceci est que vous pouvez faire de l'interface pilotée par le développement de votre API. Construire les interfaces et de remplir les blancs. La plomberie est faite pour vous.

    InformationsquelleAutor fehguy
  2. 8

    Nous avons juste commencé à jouer avec apipie pour cela. Jusqu'à présent, semble assez soignée.

    • Merci, a l'air prometteur, je vais garder ça en tête pour un futur projet. Déjà à l'aide de swagger pour l'application que je parlais quand j'ai posté la question.
    InformationsquelleAutor Michael Shimmins
  3. 6

    Swagger peut être utilisé avec des rubis comme client pour générer automatiquement les bibliothèques clientes à partir d'un Swagger-serveur conforme https://github.com/wordnik/swagger-codegen

    Si vous utilisez RoR que je pense que vous devriez regarder https://github.com/elc/rapi_doc , mais il n'est pas facile à utiliser.

    • Hey merci pour votre réponse, bien, je pense que je vais donner rapi_doc un essai. Il n'a pas l'air aussi sexy que Swagger mais au moins, son installation est plus simple.
    • Que rapi_doc lien est rompu. Je l'ai trouvé fourche en divers endroits, par exemple github.com/phuc/rapi_doc dirait qu'il n'a pas vraiment été maintenu depuis 2008 si
    InformationsquelleAutor Fivell
  4. 0

    Jetez un oeil à ApiDoco gem (https://github.com/72pulses/apidoco/) pour la documentation. Il est très facile à installer et dispose d'une bonne expérience de l'utilisateur.

    InformationsquelleAutor sufinsha