API Blueprint | API Blueprint

API Blueprint. Ett kraftfullt API-beskrivningsspråk på hög nivå för webb-API:er.

API Blueprint är enkelt och tillgängligt för alla som är involverade i API-livscykeln. Syntaxen är kortfattad men ändå uttrycksfull. Med API Blueprint kan du snabbt designa och skapa prototyper av API:er som ska skapas eller dokumentera och testa redan utplacerade verksamhetskritiska API:er.

Tutorial Tools section

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

Fokuserat på samarbete

API Blueprint är byggt för att uppmuntra till dialog och samarbete mellan intressenter i ett projekt, utvecklare och kunder vid varje punkt i API-livscykeln. Samtidigt ger API Blueprint-verktygen stöd för att uppnå målen, oavsett om det gäller API-utveckling, styrning eller leverans.

Öppen

API Blueprint är helt öppen under MIT-licensen.Dess framtid är transparent och öppen.API Blueprint behöver ingen sluten arbetsgrupp. Istället används RFC-processen som liknar RFC-processerna för Rust-språket eller Django Enhancement Proposal RFC-processerna.

För att bidra kan du skicka in ett förslag till API Blueprint RFC repository.

Hem på GitHub

Språket API Blueprint känns igen av GitHub.Sök efter API Blueprint på GitHub med hjälp avlanguage:"API Blueprint"-frågan.

Mediatypen för API Blueprint är text/vnd.apiblueprint, och standardfiltillägget är .apib. Om du använder det här tillägget kommer dina blueprints på GitHub att bli syntaxhighlighted.

Byggd för bättre API-designs

API Blueprint är byggd för att uppmuntra till bättre API-designs genom abstraktion.Målet med API Blueprint är att frikoppla delar av API:et för att möjliggöra modularitet samtidigt som det kapslar in implementeringsbeteendet i bakändan.

Modellera till exempel dina data först med hjälp av syntaxen för databeskrivning.

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

Använd och återanvänd sedan data i dina API-slutpunkter.

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

Design-first

API Blueprint handlar om design-first-filosofin. API Blueprint är ett kontrakt för ett API.Att diskutera ditt API och komma överens om kontraktet innan det utvecklas tenderar att leda till bättre API-design.

När API Blueprint är på plats kan alla testa om genomförandet lever upp till de förväntningar som ställts upp i kontraktet.

Grymma verktyg

Tack vare det breda användandet finns det en uppsjö av verktyg som är byggda för API Blueprint.Från olika fristående verktyg som mock server, dokumentation och testverktyg till fullfjädrade API-livscykellösningar.

Se avsnittet Verktyg för en lista.

Kom igång

För att komma igång med API Blueprint behöver du en redigeringsprogram för vanlig text. För den bästa redigeringsupplevelsen byter du syntaxhighlighting till Markdown eller direkt till API Blueprint (om det stöds av din editor).

När editorn är klar kan du följa API Blueprint-tutorialen.

När du har skrivit din första API Blueprint kan du diskutera API-utformningen med vänner och använda verktygen för API Blueprint. Du kan till exempel göra dokumentation, generera en mock av din tjänst eller börja testa din backend-implementation.