API Blueprint | API Blueprint

API Blueprint. Výkonný vysokoúrovňový jazyk pro popis webových API.

API Blueprint je jednoduchý a přístupný všem účastníkům životního cyklu API. Jeho syntaxe je stručná, ale přitom výrazná. Pomocí API Blueprint můžeterychle navrhovat a vytvářet prototypy API nebo dokumentovat a testovat již nasazená kritická API.

Sekce Výukové nástroje

# GET /message+ Response 200 (text/plain) Hello World!

Zaměřeno na spolupráci

API Blueprint je vytvořen tak, aby podporoval dialog a spolupráci mezi zúčastněnými stranami projektu, vývojáři a zákazníky v kterékoli fázi životního cyklu API. Současně nástroje API Blueprint poskytují podporu pro dosažení cílů, ať už jde o vývoj, správu nebo dodávku API.

Otevřený

API Blueprint je zcela otevřený pod licencí MIT, jeho budoucnost je transparentní a otevřená. API Blueprint nepotřebuje uzavřenou pracovní skupinu. Místo toho používá proces RFC podobný procesům RFC jazyka Rust nebo Django Enhancement Proposal.

Chcete-li přispět, pošlete návrh do úložiště API Blueprint RFC.

Doma na GitHubu

Jazyk API Blueprint je na GitHubu rozpoznán. hledejte API Blueprint na GitHubu pomocí dotazulanguage:"API Blueprint".

Typ média pro API Blueprint je text/vnd.apiblueprint a standardní přípona souboru je .apib. Pokud použijete toto rozšíření, budou vašeblueprinty na GitHubu zvýrazněny syntaxí.

Vytvořeno pro lepší návrhy API

API Blueprint je vytvořeno tak, aby podporovalo lepší návrhy API prostřednictvím abstrakce. cílem API Blueprint je oddělit prvky API a umožnit tak modularitu při zapouzdření chování implementace backendu.

Například nejprve modelujte data pomocí syntaxe popisu dat.

# 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]

Poté data použijte a znovu použijte ve svých koncových bodech API.

# Blog Posts ## Retrieve All Posts + Response 200 (application/json) + Attributes (array)

Design-first

API Blueprint je o filozofii design-first. Podobně jako testy při vývoji řízeném testy představuje API Blueprint smlouvu pro API.

Diskuse o vašem API a dohodnutí smlouvy před jeho vývojem vede zpravidla k lepším návrhům API.

Jakmile je váš API Blueprint vytvořen, každý může otestovat, zda implementace splňuje očekávání stanovená ve smlouvě.

Úžasné nástroje

Díky širokému rozšíření existuje nepřeberné množství nástrojů vytvořených pro API Blueprint. od různých samostatných nástrojů, jako je mock server, dokumentační a testovací nástroje, až po plnohodnotná řešení pro životní cyklus API.

Seznam najdete v části Nástroje.

Začínáme

Pro začátek práce s API Blueprint budete potřebovat textový editor. Pro co nejlepší zážitek z editace přepněte zvýraznění syntaxe na Markdown nebo přímo na API Blueprint (pokud to váš editor podporuje).

Pokud máte editor připravený, postupujte podle návodu API Blueprint.

Jakmile napíšete svůj první API Blueprint, můžete diskutovat o návrhu API s přáteli a používat nástroje pro API Blueprint. Můžete například vykreslit dokumentaci, vygenerovat maketu služby nebo začít testovat implementaci svého backendu.