API Blueprint | API Blauwdruk
API Blueprint. Een krachtige, high-level API-beschrijvingstaal voor web-API’s.
API Blueprint is eenvoudig en toegankelijk voor iedereen die betrokken is bij de API-levenscyclus. De syntaxis is beknopt maar toch expressief. Met API Blueprint kunt u snel API’s ontwerpen en prototypen maken of reeds geïmplementeerde bedrijfskritische API’s documenteren en testen.
Tutorial Tools sectie
# GET /message+ Response 200 (text/plain) Hello World!Gericht op samenwerking
API Blueprint is gebouwd om de dialoog en samenwerking tussen projectstakeholders, ontwikkelaars en klanten op elk punt in de API-levenscyclus te stimuleren. Tegelijkertijd bieden de API Blueprint tools de ondersteuning om de doelen te bereiken, of het nu gaat om API ontwikkeling, governance of delivery.
Open
API Blueprint is volledig open sourced onder de MIT licentie. De toekomst is transparant en open. API Blueprint heeft geen behoefte aan een gesloten werkgroep. In plaats daarvan maakt gebruik van de RFC-proces vergelijkbaar met Rust taal of Django Enhancement Proposal RFC processen.
Om bij te dragen, een voorstel in te dienen API Blueprint RFC repository.
Thuis op GitHub
De API Blueprint taal wordt herkend door GitHub.Zoek naar API Blueprint op GitHub met behulp van delanguage:"API Blueprint" query.
Het mediatype voor API Blueprint is text/vnd.apiblueprint, en de standaard bestandsextensie is .apib. Als u deze extensie gebruikt, zullen uw blauwdrukken op GitHub syntax-highlighted worden.
Gebouwd voor betere API ontwerpen
API Blueprint is gebouwd om betere API ontwerpen aan te moedigen door middel van abstractie. Het doel van API Blueprint is om elementen van API te ontkoppelen om modulariteit mogelijk te maken, terwijl het gedrag van de backend implementatie wordt ingekapseld.
Modelleer bijvoorbeeld eerst uw gegevens met behulp van de syntaxis voor gegevensbeschrijving.
# 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]Gebruik en hergebruik vervolgens de gegevens in uw API-eindpunten.
# Blog Posts ## Retrieve All Posts + Response 200 (application/json) + Attributes (array)Design-first
API Blueprint draait om de design-first-filosofie. Vergelijkbaar met tests voor testgestuurde ontwikkeling, vormt API Blueprint een contract voor een API. Als u uw API bespreekt en een contract afsluit voordat deze wordt ontwikkeld, leidt dit meestal tot betere API-ontwerpen.
Als uw API Blueprint er eenmaal is, kan iedereen testen of de implementatie voldoet aan de verwachtingen die in het contract zijn vastgelegd.
Awesome Tools
Dankzij de brede acceptatie is er een overvloed aan tools gebouwd voor API Blueprint.Van diverse standalone tools zoals mock server, documentatie en testingtools tot full-featured API life-cycle oplossingen.
Zie de Tools sectie voor de lijst.
Getting Started
Om te beginnen met API Blueprint heb je een plain-text editor nodig. Voor de beste editing ervaring schakel de syntax-highlighting naar Markdown of direct naar API Blueprint (indien ondersteund door uw editor).
Met editor klaar, volg de API Blueprint tutorial.
Als je eenmaal je eerste API Blueprint hebt geschreven kun je het API ontwerp bespreken met vrienden en de tools voor API Blueprint gebruiken. Bijvoorbeeld, om documentatie te renderen, een mock van uw service te genereren of te beginnen met het testen van uw backend implementatie.