API Blueprint | API Blueprint
API Blueprint. Un limbaj puternic de descriere API de nivel înalt pentru API-uri web.
API Blueprint este simplu și accesibil tuturor celor implicați în APIlifecycle. Sintaxa sa este concisă, dar expresivă. Cu API Blueprint puteți proiecta și crea rapid prototipuri de API-uri ce urmează a fi create sau documenta și testa API-uri critice de misiune deja implementate.
Secțiunea Instrumente tutoriale
# GET /message+ Response 200 (text/plain) Hello World!Concentrat pe colaborare
API Blueprint este construit pentru a încuraja dialogul și colaborarea întreparticipanții la proiect, dezvoltatori și clienți în orice punct al ciclului de viață al API-urilor. În același timp, instrumentele API Blueprint oferă suportul necesar pentru a atinge obiectivele, fie că este vorba de dezvoltarea, guvernanța sau livrarea API.
Deschis
API Blueprint este complet deschis sub licența MIT.Viitorul său este transparent și deschis.API Blueprint nu are nevoie de un grup de lucru închis. În schimb, folosește un proces RFC similar cu cel al limbajului Rust sau cu procesele RFC pentru propuneri de îmbunătățire Django.
Pentru a contribui, trimiteți o propunere la depozitul API Blueprint RFC.
La domiciliu pe GitHub
Limbajul API Blueprint este recunoscut de GitHub.Căutați API Blueprint pe GitHub folosind interogarealanguage:"API Blueprint".
Tipul media pentru API Blueprint este text/vnd.apiblueprint, iar extensia standard a fișierului este .apib. Dacă folosiți această extensie, fișierele dumneavoastrăblueprint de pe GitHub vor fi evidențiate din punct de vedere al sintaxei.
Construit pentru o mai bună proiectare a API-urilor
API Blueprint este construit pentru a încuraja o mai bună proiectare a API-urilor prin abstractizare.Scopul API Blueprint este de a decupla elementele API-ului pentru a permite modularitateaîn timp ce încapsulează comportamentul implementării backend.
De exemplu, modelați-vă mai întâi datele folosind sintaxa de descriere a datelor.
# 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]Apoi, utilizați și reutilizați datele în punctele finale ale API.
# Blog Posts ## Retrieve All Posts + Response 200 (application/json) + Attributes (array)Design-first
API Blueprint se bazează pe filozofia design-first. Similar cu testele de dezvoltare orientată spre intestin, API Blueprint reprezintă un contract pentru un API.Discutarea API-ului dvs. și stabilirea contractului înainte de a fi dezvoltat tinde să ducă la proiecte API mai bune.
După ce API Blueprint-ul dvs. este în vigoare, toată lumea poate testa dacă implementarea se ridică la așteptările stabilite în contract.
Instrumente extraordinare
Datorită adoptării sale pe scară largă, există o multitudine de instrumente construite pentru API Blueprint.De la diverse instrumente independente, cum ar fi mock server, instrumente de documentare și testare, până la soluții complete pentru ciclul de viață al API.
Vezi secțiunea Tools (Instrumente) pentru listă.
Getting Started
Pentru a începe cu API Blueprint veți avea nevoie de un editor de text simplu. Pentru cea mai bună experiență de editare comutați evidențierea sintaxei la Markdown saudirect la API Blueprint (dacă este suportat de editorul dvs.).
Cu editorul gata, urmați tutorialul API Blueprint.
După ce ați scris primul API Blueprint puteți discuta despre proiectarea API cu prietenii și puteți folosi instrumentele pentru API Blueprint. De exemplu,pentru a reda documentația, pentru a genera o machetă a serviciului dumneavoastră sau pentru a începe să testați implementarea backend-ului dumneavoastră.
.