API Blueprint | API Blueprint
API Blueprint. Egy nagy teljesítményű, magas szintű API leíró nyelv webes API-khoz.
Az API Blueprint egyszerű és elérhető az API életciklusában részt vevők számára. Szintaxisa tömör, mégis kifejező. Az API Blueprint segítségével gyorsan megtervezheti és prototípusba foglalhatja a létrehozandó API-kat, vagy dokumentálhatja és tesztelheti a már alkalmazott, kritikus fontosságú API-kat.
Tutorial Tools section
# GET /message+ Response 200 (text/plain) Hello World!
Focused on Collaboration
Az API Blueprint úgy készült, hogy az API-életciklus bármely pontján ösztönözze a párbeszédet és az együttműködést a projekt érintettjei, a fejlesztők és az ügyfelek között. Ugyanakkor az API Blueprint eszközei támogatást nyújtanak a célok eléréséhez, legyen szó API fejlesztésről, irányításról vagy átadásról.
Open
Az API Blueprint teljesen nyílt forráskódú a MIT licenc alatt.A jövője átlátható és nyitott.Az API Blueprintnek nincs szüksége zárt munkacsoportra. Ehelyett a Rust nyelvhez vagy a Django Enhancement Proposal RFC folyamatához hasonló RFC folyamatot használ.
A hozzájáruláshoz küldjön javaslatot az API Blueprint RFC tárolójába.
A GitHubon
Az API Blueprint nyelvet a GitHub felismeri.Keresse az API Blueprintet a GitHubon alanguage:"API Blueprint"
lekérdezéssel.
Az API Blueprint médiatípusa text/vnd.apiblueprint
, a szabványos fájlkiterjesztés pedig .apib
. Ha ezt a kiterjesztést használja, a GitHubon található Blueprintjei szintaxis-kiemeltek lesznek.
Built for better API Designs
Az API Blueprint azért készült, hogy az absztrakció révén jobb API-tervezéseket ösztönözzön.Az API Blueprint célja az API elemeinek szétválasztása a modularitás érdekében, miközben a backend implementációs viselkedését kapszulázza.
Modellezze például először az adatait az adatleíró szintaxis segítségével.
# 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]
Majd használja és használja újra az adatokat az API végpontjaiban.
# Blog Posts ## Retrieve All Posts + Response 200 (application/json) + Attributes (array)
Design-first
Az API Blueprint a design-first filozófiáról szól. Hasonlóan az intest-vezérelt fejlesztés tesztjeihez, az API Blueprint egy szerződést jelent az API számára.Az API megvitatása és a szerződésben való megegyezés a fejlesztés előtt általában jobb API-tervezéshez vezet.
Amikor az API Blueprint már a helyén van, mindenki tesztelheti, hogy a megvalósítás megfelel-e a szerződésben meghatározott elvárásoknak.
Félelmetes eszközök
A széles körű elterjedtségének köszönhetően rengeteg eszköz készült az API Blueprinthez.A különböző önálló eszközöktől kezdve, mint például a mock szerver, dokumentáció és tesztelési eszközök, egészen a teljes funkcionalitású API életciklus megoldásokig.
A listát az Eszközök részben találja.
Elkezdés
Az API Blueprint használatának megkezdéséhez egy egyszerű szövegszerkesztőre lesz szüksége. A legjobb szerkesztési élmény érdekében kapcsolja át a szintaxis-kiemelést Markdownra vagy közvetlenül az API Blueprintre (ha a szerkesztője támogatja).
Ha a szerkesztő készen áll, kövesse az API Blueprint bemutatót.
Mihelyt megírta az első API Blueprintjét, megvitathatja az API tervezését barátaival és használhatja az API Blueprint eszközeit. Például dokumentáció készítéséhez, a szolgáltatása mockjának generálásához vagy a backend implementációjának teszteléséhez.