Scalar

Scalar est une plateforme pour créer une documentation d'API qui a un aspect professionnel et fonctionne de manière fluide. Vous fournissez votre document OpenAPI, et Scalar le transforme en pages faciles à lire avec des exemples et des outils de test intégrés.

La plateforme propose plusieurs produits qui fonctionnent ensemble. La Référence API affiche votre documentation dans une mise en page épurée. Le Client API permet aux développeurs de tester directement les points de terminaison. La plateforme inclut également des outils pour gérer plusieurs versions de vos documents API et synchroniser avec GitHub.

Scalar est entièrement open-source, ce qui signifie que le code est public et gratuit à utiliser. Vous pouvez l’héberger vous-même ou utiliser leur service cloud. Le plan gratuit couvre les fonctionnalités de base, tandis que les plans payants ajoutent des outils de collaboration, des domaines personnalisés et un meilleur support.

Utiliser Scalar est simple et ne nécessite pas de configuration complexe. Voici les étapes pour commencer :

• Visitez le site web de Scalar et créez un compte gratuit pour sauvegarder votre travail. Vous obtiendrez un sous-domaine gratuit comme votrenom.apidocumentation.com.

• Importez votre document OpenAPI en collant une URL, en téléchargeant un fichier ou en vous connectant à GitHub. Scalar prend en charge les formats JSON et YAML.

• Choisissez un thème et personnalisez les couleurs pour correspondre à votre marque. Vous pouvez ajouter du CSS personnalisé si vous souhaitez un contrôle plus précis sur le design.

• Rédigez des guides supplémentaires à l’aide de l’éditeur. Ces pages expliquent des concepts qui vont au-delà des pages de référence automatiques.

• Testez vos points de terminaison API avec le client intégré. Cliquez sur un point de terminaison, ajoutez des paramètres et envoyez des requêtes pour voir les réponses en temps réel.

• Partagez votre documentation avec votre équipe ou rendez-la publique. Vous pouvez définir des permissions pour contrôler qui peut éditer ou consulter.

• Documentation API magnifique à partir de fichiers OpenAPI

• Tests intégrés avec client API

• Intégration GitHub et synchronisation automatique

• Domaines personnalisés et thèmes

• Intégrations de frameworks pour toutes les principales plateformes

• Recherche propulsée par TypeSense

• Support de plusieurs versions d'API

• Guides Markdown et MDX

• Outils de collaboration en équipe

• Open-source et auto-hébergeable

• Sous-domaine gratuit inclus

• Support CSS et JavaScript personnalisés