API Blueprint | API Blueprint
API Blueprint. Tehokas korkean tason API-kuvauskieli web-rajapintakäyttöliittymille.
API Blueprint on yksinkertainen ja helppokäyttöinen kaikille API:n elinkaareen osallistuville. Sen syntaksi on tiivis mutta ilmeikäs. API Blueprintin avulla voitnopeasti suunnitella ja prototyypittää luotavia API:ita tai dokumentoida ja testata jo käytössä olevia tehtäväkriittisiä API:ita.
Työkalut-osio
# GET /message+ Response 200 (text/plain) Hello World!
Keskeisesti yhteistyöhön keskittyvä
API Blueprint on luotu rohkaisemaan vuoropuhelua ja yhteistyötä projektin sidosryhmien, ohjelmistokehittäjien ja asiakkaiden välillä API:n elinkaaren missä tahansa vaiheessa. Samalla API Blueprint -työkalut tarjoavat tukea tavoitteiden saavuttamiseen, olipa kyse sitten API-kehityksestä, hallinnoinnista tai toimituksesta.
Open
API Blueprint on täysin avoimen lähdekoodin MIT-lisenssin alainen.Sen tulevaisuus on läpinäkyvä ja avoin.API Blueprint ei tarvitse suljettua työryhmää. Sen sijaan se käyttää RFC-prosessia, joka on samanlainen kuin Rust-kielen tai Djangon parannusehdotusten RFC-prosessit.
Voidaksesi osallistua, lähetä ehdotus API Blueprintin RFC-repositoryyn.
Kotona GitHubissa
GitHub tunnistaa API Blueprint -kielen.Etsi API Blueprint -kieli GitHubista käyttämällälanguage:"API Blueprint"
-kyselyä.
API Blueprint -kielen mediatyyppi on text/vnd.apiblueprint
, ja tiedostojen vakiopääte on .apib
. Jos käytät tätä laajennusta sinunblueprintit GitHubissa saavat syntax-highlighted.
Built for better API Designs
API Blueprint on rakennettu kannustamaan parempiin API-suunnitelmiin abstraktion avulla.API Blueprintin tavoitteena on irrottaa API:n elementit toisistaan modulaarisuuden mahdollistamiseksi samalla kun se kapseloi backend-toteutuksen käyttäytymisen.
Mallinna esimerkiksi datasi ensin käyttämällä datan kuvaussyntaksia.
# 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]
Sitten käytä ja uusiokäytä dataa API-päätepisteissäsi.
# Blog Posts ## Retrieve All Posts + Response 200 (application/json) + Attributes (array)
Suunnittelu ensin
API Blueprint on suunnittelun ensin -filosofiaa. Samoin kuin testit testivetoisessa kehityksessä, API Blueprint edustaa sopimusta API:lle.Keskustelemalla API:sta ja sopimalla sopimuksesta ennen sen kehittämistä on tapana johtaa parempaan API-suunnitteluun.
Kun API Blueprint on valmis, kaikki voivat testata, täyttääkö toteutus sopimuksessa asetetut odotukset.
Valmiita työkaluja
Sen laajan hyväksynnän ansiosta API Blueprintille on rakennettu lukuisia työkaluja.Erilaisista erillisistä työkaluista, kuten mock-palvelimesta, dokumentointi- ja testaustyökaluista aina API:n koko elinkaaren kattaviin ratkaisuihin.
Luettelo on kohdassa Työkalut.
Aloittaminen
Aloittaaksesi API Blueprintin käytön tarvitset tavallisen tekstieditorin. Parhaan muokkauskokemuksen saamiseksi vaihda syntaksin korostus Markdowniin tai suoraan API Blueprintiin (jos editorisi tukee sitä).
Kun editori on valmis, seuraa API Blueprintin opetusohjelmaa.
Kun olet kirjoittanut ensimmäisen API Blueprintin, voit keskustella API-suunnittelusta ystävien kanssa ja käyttää API Blueprintin työkaluja. Voit esimerkiksi renderöidä dokumentaatiota, luoda mockin palvelustasi tai aloittaa backend-toteutuksesi testaamisen.