API Blueprint | API Blueprint
API Blueprint. Un puissant langage de description d’API de haut niveau pour les API web.
API Blueprint est simple et accessible à toutes les personnes impliquées dans le cycle de vie des API. Sa syntaxe est concise mais expressive. Avec API Blueprint, vous pouvez rapidement concevoir et prototyper des API à créer ou documenter et tester des API critiques déjà déployées.
Section Outils Tutoriels
# GET /message+ Response 200 (text/plain) Hello World!Focus sur la collaboration
API Blueprint est construit pour encourager le dialogue et la collaboration entre les parties prenantes du projet, les développeurs et les clients à tout moment du cycle de vie de l’API. Dans le même temps, les outils d’API Blueprint fournissent le soutien nécessaire pour atteindre les objectifs, qu’il s’agisse de développement d’API, de gouvernance ou de livraison.
Open
API Blueprint est entièrement open sourced sous la licence MIT.Son avenir est transparent et ouvert.API Blueprint n’a pas besoin d’un groupe de travail fermé. Au lieu de cela, il utilise le processus RFCprocess similaire au langage Rust ou aux processus RFC de proposition d’amélioration de Django.
Pour contribuer, soumettez une proposition au dépôt RFC d’API Blueprint.
À domicile sur GitHub
Le langage API Blueprint est reconnu par GitHub.Recherchez API Blueprint sur GitHub en utilisant la requêtelanguage:"API Blueprint".
Le type de média pour API Blueprint est text/vnd.apiblueprint, et l’extension de fichier standard est .apib. Si vous utilisez cette extension, vosblueprints sur GitHub seront mis en évidence par la syntaxe.
Construit pour de meilleures conceptions d’API
API Blueprint est construit pour encourager de meilleures conceptions d’API par l’abstraction.L’objectif d’API Blueprint est de découpler les éléments de l’API pour permettre la modularité tout en encapsulant le comportement de mise en œuvre du backend.
Par exemple, modélisez d’abord vos données en utilisant la syntaxe de description des données.
# Data Structures## Blog Post (object)+ id: 42 (number, required)+ text: Hello World (string)+ author (Author) - Author of the blog post.## Author (object)+ name: Boba Fett+ email: [email protected]Puis, utilisez et réutilisez les données dans vos terminaux API.
# Blog Posts ## Retrieve All Posts + Response 200 (application/json) + Attributes (array)Design-first
API Blueprint est tout au sujet de la philosophie design-first. Semblable aux tests du développement piloté par les tests, API Blueprint représente un contrat pour une API.Discuter de votre API et régler le contrat avant qu’elle ne soit développée tend à conduire à de meilleures conceptions d’API.
Une fois que votre API Blueprint est en place, tout le monde peut tester si l’implémentation répond aux attentes fixées dans le contrat.
Awesome Tools
Grâce à sa large adoption, il existe une pléthore d’outils construits pour API Blueprint.De divers outils autonomes tels que le serveur de simulacre, la documentation et les outils de test à des solutions complètes de cycle de vie API.
Voir la section Outils pour la liste.
Démarrer
Pour démarrer avec API Blueprint, vous aurez besoin d’un éditeur de texte brut. Pour la meilleure expérience d’édition, basculez la mise en évidence de la syntaxe vers Markdown ou directement vers API Blueprint (si votre éditeur le supporte).
Avec l’éditeur prêt, suivez le tutoriel API Blueprint.
Une fois que vous avez écrit votre premier API Blueprint, vous pouvez discuter de la conception de l’API avec vos amis et utiliser les outils pour API Blueprint. Par exemple,pour rendre la documentation, générer une maquette de votre service ou commencer à tester l’implémentation de votre backend.
>