API Blueprint | API Blueprint
API Blueprint. Un potente linguaggio di descrizione API di alto livello per le API web.
API Blueprint è semplice e accessibile a chiunque sia coinvolto nel ciclo di vita delle API. La sua sintassi è concisa ma espressiva. Con API Blueprint è possibile progettare rapidamente e prototipare API da creare o documentare e testare API mission-critical già distribuite.
Sezione Strumenti Tutorial
# GET /message+ Response 200 (text/plain) Hello World!Focalizzato sulla collaborazione
API Blueprint è costruito per incoraggiare il dialogo e la collaborazione tra le parti interessate al progetto, gli sviluppatori e i clienti in qualsiasi punto del ciclo API. Allo stesso tempo, gli strumenti di API Blueprint forniscono il supporto per raggiungere gli obiettivi, che si tratti di sviluppo API, governance o consegna.
Open
API Blueprint è completamente open sourced sotto la licenza MIT.Il suo futuro è trasparente e aperto.API Blueprint non ha bisogno di un gruppo di lavoro chiuso. Invece usa il processo RFC simile al linguaggio Rust o ai processi RFC di Django Enhancement Proposal.
Per contribuire, inviare una proposta al repository RFC di API Blueprint.
A casa su GitHub
Il linguaggio API Blueprint è riconosciuto da GitHub.Cerca API Blueprint su GitHub usando la querylanguage:"API Blueprint".
Il tipo di media per API Blueprint è text/vnd.apiblueprint, e l’estensione standard del file è .apib. Se usi questa estensione i tuoi Blueprint su GitHub saranno evidenziati dalla sintassi.
Costruito per una migliore progettazione delle API
API Blueprint è costruito per incoraggiare una migliore progettazione delle API attraverso l’astrazione.L’obiettivo di API Blueprint è di disaccoppiare gli elementi delle API per permettere la modularità mentre incapsula il comportamento dell’implementazione del backend.
Per esempio, modella prima i tuoi dati usando la sintassi di descrizione dei dati.
# 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]Poi, usa e riutilizza i dati nei tuoi endpoint API.
# Blog Posts ## Retrieve All Posts + Response 200 (application/json) + Attributes (array)Design-first
API Blueprint è tutto sulla filosofia design-first. Simile ai test di sviluppo intest-driven, API Blueprint rappresenta un contratto per un’API.Discutere la vostra API e stabilire il contratto prima che sia sviluppata tende a portare a migliori progetti API.
Una volta che la vostra API Blueprint è in atto tutti possono testare se l’implementazione è all’altezza delle aspettative stabilite nel contratto.
Strumenti fantastici
Grazie alla sua ampia adozione c’è una pletora di strumenti costruiti per API Blueprint.Da vari strumenti standalone come mock server, documentazione e strumenti di test a soluzioni complete del ciclo di vita API.
Vedi la sezione Strumenti per la lista.
Iniziare
Per iniziare con API Blueprint avrai bisogno di un editor di testo semplice. Per la migliore esperienza di editing passa l’evidenziazione della sintassi a Markdown o direttamente ad API Blueprint (se supportato dal tuo editor).
Con l’editor pronto, segui il tutorial API Blueprint.
Una volta che hai scritto il tuo primo API Blueprint puoi discutere il design delle API con gli amici e usare gli strumenti per API Blueprint. Per esempio, per rendere la documentazione, generare un mock del vostro servizio o iniziare a testare l’implementazione del vostro backend.
Per quanto riguarda le API Blueprint, è possibile utilizzare gli strumenti di API Blueprint.