API Blueprint | API Blueprint
API Blueprint. Eine leistungsstarke High-Level-API-Beschreibungssprache für Web-APIs.
API Blueprint ist einfach und für alle am API-Lebenszyklus Beteiligten zugänglich. Seine Syntax ist prägnant und dennoch aussagekräftig. Mit API Blueprint können Sie schnell zu erstellende APIs entwerfen und prototypisieren oder bereits eingesetzte geschäftskritische APIs dokumentieren und testen.
Tutorial Tools section
# GET /message+ Response 200 (text/plain) Hello World!Focused on Collaboration
API Blueprint wurde entwickelt, um den Dialog und die Zusammenarbeit zwischen Projektbeteiligten, Entwicklern und Kunden an jedem Punkt des API-Lebenszyklus zu fördern. Gleichzeitig bieten die API Blueprint Tools die Unterstützung, um die Ziele zu erreichen, sei es API-Entwicklung, -Governance oder -Lieferung.
Open
API Blueprint ist vollständig Open Source unter der MIT-Lizenz.Seine Zukunft ist transparent und offen.API Blueprint braucht keine geschlossene Arbeitsgruppe. Stattdessen verwendet es den RFC-Prozess, ähnlich wie Rust oder Django Enhancement Proposal RFC-Prozesse.
Um beizutragen, reichen Sie einen Vorschlag im API Blueprint RFC Repository ein.
Zu Hause auf GitHub
Die API Blueprint Sprache wird von GitHub erkannt.Suchen Sie nach API Blueprint auf GitHub mit derlanguage:"API Blueprint" Abfrage.
Der Medientyp für API Blueprint ist text/vnd.apiblueprint, und die Standard-Dateierweiterung ist .apib. Wenn Sie diese Erweiterung verwenden, werden Ihre Blueprints auf GitHub syntax-highlighted.
Built for better API Designs
API Blueprint wurde entwickelt, um bessere API Designs durch Abstraktion zu fördern.Das Ziel von API Blueprint ist es, Elemente der API zu entkoppeln, um Modularität zu ermöglichen, während das Verhalten der Backend-Implementierung gekapselt wird.
Modellieren Sie zum Beispiel Ihre Daten zuerst mit der Datenbeschreibungssyntax.
# 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]Nutzen und verwenden Sie dann die Daten in Ihren API-Endpunkten.
# Blog Posts ## Retrieve All Posts + Response 200 (application/json) + Attributes (array)Design-first
API Blueprint steht ganz im Zeichen der Design-first-Philosophie. Ähnlich wie bei der testgetriebenen Entwicklung stellt der API Blueprint einen Vertrag für eine API dar.
Die Diskussion über die API und die Festlegung des Vertrags vor der Entwicklung führt in der Regel zu besseren API-Designs.
Wenn der API Blueprint erstellt ist, kann jeder testen, ob die Implementierung die im Vertrag festgelegten Erwartungen erfüllt.
Gute Tools
Dank der breiten Akzeptanz gibt es eine Fülle von Tools, die für API Blueprint entwickelt wurden – von verschiedenen eigenständigen Tools wie Mock Server, Dokumentation und Testtools bis hin zu vollwertigen Lösungen für den API Lifecycle.
Die Liste finden Sie im Abschnitt Tools.
Getting Started
Um mit API Blueprint zu beginnen, benötigen Sie einen Texteditor. Für die beste Bearbeitungserfahrung schalten Sie die Syntax-Hervorhebung auf Markdown oder direkt auf API Blueprint um (wenn Ihr Editor dies unterstützt).
Wenn der Editor bereit ist, folgen Sie dem API Blueprint-Tutorial.
Wenn Sie Ihren ersten API Blueprint geschrieben haben, können Sie das API-Design mit Freunden diskutieren und die Werkzeuge für API Blueprint verwenden. Zum Beispiel, um Dokumentation zu erstellen, ein Mock Ihres Dienstes zu generieren oder Ihre Backend-Implementierung zu testen.