Stoplight Avantages et Inconvénients

- Un éditeur visuel robuste pour les documents OpenAPI

- Aperçu instantané des modifications de spécifications API

- Capacité à examiner en interne les modifications de spécifications non publiées

- Collaboration en équipe

- Intégration Git

- Outils de linting et de simulation intégrés

- Génération automatique de documents API Avis collecté par et hébergé sur G2.com.

- L'interface utilisateur est un peu déroutante, elle ressemble à un outil construit par des développeurs. Bien qu'elle ait reçu de grandes améliorations récemment

- Les documents générés pourraient avoir une navigation et une découverte plus faciles

- Les documents générés ne sont pas réactifs (mais ils prévoient de résoudre ce problème)

- Le lien croisé entre les articles ou les points de terminaison de l'API est un casse-tête

- Pas assez de contrôle sur les éléments du document OpenAPI qui apparaissent dans la barre latérale de navigation et dans quel ordre

- Pas assez de personnalisation lorsque vous intégrez les documents de Stoplight dans votre propre site, mais ils prévoient de résoudre ce problème dans la prochaine version Avis collecté par et hébergé sur G2.com.

L'interface utilisateur simple rend la création de maquettes pour les points de terminaison API et les modèles de base de données un jeu d'enfant. Ayant migré d'autres plateformes qui vous obligent à développer vos spécifications API dans des formats YAML/JSON, j'ai réalisé que je perdais plus de temps à comprendre la structure pour écrire des maquettes API qu'à écrire les maquettes elles-mêmes. Depuis que j'utilise Stoplight, presque tout mon temps consacré à la planification de l'architecture a été réellement passé à planifier l'architecture, plutôt qu'à devoir valider mon schéma toutes les quelques minutes.

La quantité de détails que Stoplight me permet de fournir pour mes modèles et points de terminaison, tout cela via un éditeur UI sans jamais avoir besoin de passer au code, est fantastique. Stoplight offre également la possibilité de modifier le code qu'il génère (soit au format JSON ou YAML), bien que je l'utilise rarement. Avis collecté par et hébergé sur G2.com.

Il n'y a rien à propos de Stoplight que je n'aime pas, bien qu'il y ait quelques irritations que j'ai de mon temps d'utilisation du service.

Je fournis généralement un exemple de réponse API pour chaque statut HTTP que mes points de terminaison renvoient. La majorité des réponses incluent souvent l'utilisation de modèles Stoplight (comme le retour d'un modèle utilisateur à partir d'un point de terminaison `GET /users/:id`), bien que Stoplight ne mette pas à jour les exemples si le modèle retourné dans l'exemple est modifié. Cela a peu d'impact sur mon petit projet, bien que je puisse imaginer des projets à grande échelle rencontrant des problèmes où des modèles obsolètes sont retournés dans le cadre de l'exemple.

Un autre problème mineur est le manque d'options de tri pour les schémas. Bien que je comprenne complètement que les objets JSON n'ont pas réellement d'ordre, je me vois souvent passer à l'éditeur de code juste pour déplacer les champs API dans mes schémas afin d'ajouter un peu plus de logique à ce que le modèle représente. Par exemple, j'ai tendance à garder tous les champs de "métadonnées" (comme un titre, un slug, etc.) en haut du schéma, et tout le reste en dessous. Lorsqu'on itère constamment sur ces conceptions, les choses sont souvent déplacées et séparées, ce qui peut rendre le modèle plus compliqué qu'il ne l'est. Avis collecté par et hébergé sur G2.com.

Spotlight a une fonctionnalité qui dispose d'un outil de remplissage automatique basé sur l'IA qui rend la construction de nouvelles API très facile, et s'il est basé sur un autre modèle existant, c'est encore plus simple. Avis collecté par et hébergé sur G2.com.

Je pense que, comme la plupart des choses, le coût pourrait toujours être amélioré. Stoplight est capable de soutenir de plus grandes entreprises, mais leur modèle de tarification les empêche d'aider les plus petites. Avis collecté par et hébergé sur G2.com.

* Capacité à gérer la documentation en tant que Code, dans un dépôt Git, intégration CI/CD et également capacité à prévisualiser et publier.

* Stoplight est la seule solution SaaS qui a permis de garder le flux de travail plus proche du flux de travail des développeurs.

* Sa capacité à permettre aux utilisateurs techniques et non techniques de collaborer est impressionnante.

* Publier l'API et la documentation générale relative les unes aux autres est merveilleux. Avis collecté par et hébergé sur G2.com.

* Les images doivent être accessibles au public.

* Les images dans un dépôt Git privé ne sont pas prises en charge.

* Impossible d'avoir une documentation liée à plusieurs "environnements". Elle n'a que des vues de pré-publication et de publication. Si elle permettait un moyen simple de lier plusieurs environnements à la documentation correspondante et de les promouvoir ensemble, cela aurait été plus génial. Avis collecté par et hébergé sur G2.com.

Ce produit est fantastique. C'est une aide de surveillance robuste pour la base de données. C'est le meilleur. Avis collecté par et hébergé sur G2.com.

rien n'est désagréable, seule une chose est que le modèle de tarification devient plus élevé, donc si une petite entreprise ne peut pas se le permettre Avis collecté par et hébergé sur G2.com.

Le feu tricolore m'a permis de me lancer dans la rédaction des documents API immédiatement sans aucun tracas.

Tout d'abord, l'interface était incroyablement intuitive, et il était simple de faire des choses simples comme créer de nouveaux manuels de page et rédiger l'API elle-même. Lorsque je me suis connecté pour la première fois, il ne m'a fallu que quelques clics pour commencer à écrire.

La mise en page par défaut était également d'une apparence incroyablement professionnelle, et pour ceux qui, comme moi, n'ont pas besoin de fioritures en termes d'apparence et de convivialité de la documentation, vous trouverez Stoplight plus que suffisant. Avis collecté par et hébergé sur G2.com.

L'un des problèmes avec les documents générés est le manque de réactivité mobile de la documentation générée, mais c'est déjà sur leur feuille de route.

Ce n'est pas un problème majeur car les documents API sont rarement consultés sur le téléphone, mais il y a des consommateurs potentiels qui consultent la documentation en utilisant leur téléphone et cela peut être une cause de dissuasion. Avis collecté par et hébergé sur G2.com.

Plateforme très facile à utiliser qui propose constamment de nouvelles fonctionnalités pour aider avec tout ce qui concerne les API. Excellents blogs sur les meilleures pratiques et les conseils pour concevoir et construire des API. J'aime aussi la capacité de simulation intégrée et le fait que les réponses peuvent être dynamiques et même générées en utilisant Faker pour les rendre plus réalistes. Avis collecté par et hébergé sur G2.com.

Les coûts de licence peuvent être assez élevés pour les petites équipes où tous les membres doivent modifier les spécifications.

Leurs temps de réponse du support peuvent être un peu lents parfois, surtout pour moi étant donné que je suis basé en Australie et qu'ils sont de l'autre côté du globe, ce qui signifie que cela peut parfois prendre quelques jours pour obtenir une réponse à mes demandes. Avis collecté par et hébergé sur G2.com.

Il a une interface rafraîchissante; utilise également le versioning dans GitLab. C'est une excellente fonctionnalité. Le mode sombre est incroyable; il semble plus propre. De plus, je peux choisir d'utiliser la structure JSON ou YAML. Je suis enthousiaste quant à l'évolution de cet outil à l'avenir. Avis collecté par et hébergé sur G2.com.

Vous ne pouvez pas exporter en JSON vos modèles ou structures créés dans les réponses personnalisées. Ce serait une fonctionnalité intéressante d'exporter des exemples réalisés avec l'interface utilisateur en YAML ou JSON. Créer une nouvelle branche pour chaque commit peut créer un désordre dans Gitlab. Le menu de navigation dans le tableau de bord présenterait les points de terminaison dans un dossier, pas tous au même niveau. Avis collecté par et hébergé sur G2.com.

J'ai aimé la simplicité de la configuration de la documentation API avec le mock et toutes les fonctionnalités. C'est très facile à partager et possède une interface utilisateur propre et simple. J'aime aussi que tous les fichiers soient stockés en tant que YAML dans votre propre dépôt GitHub, ce qui permet de migrer facilement vers un autre outil si nécessaire. Avis collecté par et hébergé sur G2.com.

J'aurais aimé voir plus de contrôle sur les paramètres de partage de lien. Peut-être que je veux qu'il soit privé ou visible seulement pour quelques personnes, etc. De plus, l'intégration du produit peut être améliorée. Pour la plupart, j'avais des connaissances à ce sujet, donc j'ai pu comprendre les choses, mais en général, les gens pourraient avoir besoin d'aide pour commencer. Avis collecté par et hébergé sur G2.com.

L'interface utilisateur, références aux schémas, serveur simulé, intégration GIT, plan gratuit pour utiliser le service Avis collecté par et hébergé sur G2.com.

Le manque d'opérations en masse, des problèmes de performance lors de l'ouverture des documents, le temps de réponse aux tickets relativement lent. Avis collecté par et hébergé sur G2.com.