Stoplight Avantages et Inconvénients

L'organisation des points de terminaison et des modèles, ainsi que la documentation en ligne. Avis collecté par et hébergé sur G2.com.

Parfois, je suis confus en essayant de trouver un modèle que j'ai sauvegardé par erreur sur des objets partagés. Il pourrait y avoir un message de confirmation avant ce type d'action. Avis collecté par et hébergé sur G2.com.

Les fonctionnalités de conception collaborative de l'API OAS de Stoplight ont été extrêmement précieuses pour inciter notre équipe à aborder les lacunes des API pour plusieurs de nos services. Des équipes peuvent être formées et assignées à des API spécifiques en cours de développement pour l'organisation. L'outil lui-même a permis à nos équipes de traiter les API manquantes ou déficientes pour plusieurs services, et de le faire de manière conforme à l'OAS. Dans la plupart des cas, les services existaient déjà mais n'avaient pas d'API (ou une API limitée). Stoplight a favorisé une intégration rapide et peu coûteuse en heures de travail des développeurs et une conception d'API ultérieure pour remédier aux lacunes. Dans le cas d'un service nouvellement ajouté, Stoplight a permis à l'équipe d'adopter une approche axée sur l'API, ce qui était jusqu'à présent rare pour nous et n'aurait probablement pas eu lieu--ou pas avec une clarté et un formalisme suffisants--sans Stoplight. Notre groupe est petit, avec des développeurs généralement responsables de la plupart des phases du développement logiciel de leurs projets assignés et peu de processus formels. L'incorporation de Stoplight dans les processus de développement existants a été accueillie très positivement et n'a pas entraîné de coûts d'intégration ou d'opportunité élevés, ce qui était une exigence clé vitale. L'utilisation de Stoplight a mis davantage l'accent sur la conception de l'API avant l'implémentation, permettant une meilleure planification, dans certains cas une révision, une contribution par d'autres membres de l'équipe, et une mise en œuvre légèrement plus rapide et avec une portée plus grande que ce qui aurait été réalisé autrement. Avis collecté par et hébergé sur G2.com.

Comme certains autres, nous avons également été intégrés à une version bêta de Stoplight Next, ce qui a causé quelques problèmes au départ. Cependant, comme cela a coïncidé avec le besoin des membres de l'équipe de combler des lacunes de connaissances concernant l'OAS, l'effet de ces problèmes a été mineur. Actuellement, nous rencontrons plus de problèmes avec la publication de la documentation (et des spécifications OAS, disponibles via l'API) et la présentation de la documentation de manière agréable. Cela peut également refléter notre manque de familiarité avec les capacités, ou peut-être refléter des contraintes dans la production de documentation de Stoplight ; nous ne sommes pas encore sûrs. De plus, nous avons besoin de documentation API non-OAS, bien que cela puisse être hors du champ d'application de Stoplight. Avis collecté par et hébergé sur G2.com.

Après avoir évalué plusieurs produits pour documenter plusieurs API REST - Postman, Swagger, API Blueprint et le principal différenciateur pour moi étaient :

- la capacité de mélanger la documentation de style OAS et les pages Markdown, offrant un outil tout-en-un pour rédiger l'ensemble de la documentation de l'API.

- un éditeur agréable pour le document OAS, qui offre à la fois une interface utilisateur et un moyen d'éditer directement les données JSON.

L'équipe a été très réactive aux questions pendant l'essai, et après être devenu un client payant. Ils ont également été ouverts à mes demandes de fonctionnalités.

La nouvelle version (Next) a évolué agréablement depuis son lancement il y a quelques mois. Avis collecté par et hébergé sur G2.com.

J'ai commencé à utiliser StopLight lorsque Next était en version bêta. J'ai rencontré quelques problèmes mineurs, mais l'équipe a été réactive pour les résoudre et je n'ai pas rencontré de problèmes depuis des semaines. Avis collecté par et hébergé sur G2.com.

La capacité de contribuer avec un certain nombre de personnes à la même spécification. Ce qui est traduit en oas sous le capot. La facilité de définir des modèles et des tests dans l'outil. Publier automatiquement la documentation en html... Avis collecté par et hébergé sur G2.com.

Le même utilisateur au sein de plusieurs organisations est facturé dans chaque organisation. Au sein de notre entreprise, nous utilisons Stoplight pour tous nos clients, mais lorsque le client souhaite contribuer, nous devons créer un projet dans une organisation distincte (de cette manière, le client ne peut pas voir les autres projets des autres clients). L'inconvénient est que chaque utilisateur de notre côté est facturé pour chaque organisation. Avis collecté par et hébergé sur G2.com.

J'aime à quel point Stoplight est accessible à tout le monde dans notre organisation. C'est devenu un outil essentiel pour planifier et organiser notre API - un outil que même les personnes non techniques comprennent et saisissent.

J'aime aussi la documentation hébergée - elle est rapide et stable. Avis collecté par et hébergé sur G2.com.

Je suis habitué à la spécification OpenAPI (swagger). Parfois, il est vraiment difficile de comprendre comment faire quelque chose avec Stoplight que je sais déjà faire dans la spécification OpenAPI. Avis collecté par et hébergé sur G2.com.

As a Technical writer I need a friendly tool, with an easy-to-use interface so I can better collaborate with the development teams in the development and review of the documentation of our APIs. Its integration with Git allows teams to collaborative in a coordinated way. Avis collecté par et hébergé sur G2.com.

Stoplight seems to be an immature tool yet, so now and them I stumble upon errors, or I miss things that I think should be there already. For example, I’ve noticed than when had unsaved changes, Stoplight wouldn’t make me aware of that, and then I’d lose my work (This is fixed now). Avis collecté par et hébergé sur G2.com.

Concevoir une API est extrêmement intuitif et simple. Les tests simulés sont faciles à configurer. Nous permettons le développement simultané du front-end et du back-end selon un contrat convenu défini dans Stoplight. Avis collecté par et hébergé sur G2.com.

Gestion des modèles communs et des réponses à travers les projets. Dans un monde de microservices, nous définissons de nombreux projets stoplight, cependant, il y a des éléments communs que nous aimerions partager entre ces projets. Rendre cela plus fluide serait un gain de temps considérable. Avis collecté par et hébergé sur G2.com.

La simplicité lors du partage des spécifications d'API avec des collègues et la possibilité pour tous les utilisateurs de modifier ces spécifications. La documentation générée est un autre aspect positif. Enfin, le fait que nous puissions toujours modifier directement la spécification du code dans certains cas où nous pouvons simplement copier depuis un autre emplacement. Avis collecté par et hébergé sur G2.com.

Difficile d'utiliser le versionnage. Une fonctionnalité exceptionnelle serait l'historique des modifications, même si c'est juste localement. Avis collecté par et hébergé sur G2.com.

Organisation de l'interface utilisateur, simulation, utilisation prête à l'emploi, etc. Avis collecté par et hébergé sur G2.com.

La gestion des versions/commits est étrange/bizarre. Pas de documentation disponible. Pas de moyen clair pour avoir des branches actuelles vs WIP de la conception de l'API. J'ai eu un aperçu de Stoplight Next et j'étais enthousiasmé par les éléments qui y apparaissaient, mais aucune documentation que je pouvais facilement trouver, donc nous avions peur de faire le saut. Avis collecté par et hébergé sur G2.com.

Stoplight a une excellente interface pour la conception d'API, la documentation et la génération automatique d'une spécification swagger. Le service est excellent et l'équipe est réactive aux retours. Avis collecté par et hébergé sur G2.com.

Nous utilisons une version plus ancienne de Stoplight et nous n'avons pas encore pris le temps de passer à la nouvelle version. Avis collecté par et hébergé sur G2.com.