API Blueprint | API Blueprint

API Blueprint. Et kraftfuldt API-beskrivelsessprog på højt niveau til web-API’er.

API Blueprint er enkelt og tilgængeligt for alle, der er involveret i API-livscyklusen. Dens syntaks er kortfattet og alligevel udtryksfuld. Med API Blueprint kan du hurtigt designe og lave prototyper af API’er, der skal oprettes, eller dokumentere og teste allerede implementerede missionskritiske API’er.

Tutorial Tools section

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

Fokuseret på samarbejde

API Blueprint er bygget til at fremme dialog og samarbejde mellem projektets interessenter, udviklere og kunder på ethvert tidspunkt i API-livscyklussen. Samtidig giver API Blueprint-værktøjerne støtte til at nå målene, uanset om det er API-udvikling, styring eller levering.

Open

API Blueprint er fuldstændig open source under MIT-licensen, og dens fremtid er gennemsigtig og åben.API Blueprint har ikke brug for en lukket arbejdsgruppe. I stedet bruger den RFC-processen svarende til RFC-processer for Rust-sprog eller Django Enhancement Proposal RFC-processer.

For at bidrage skal du indsende et forslag til API Blueprint RFC-repositoriet.

Hjemme på GitHub

Sproget API Blueprint er anerkendt af GitHub.Søg efter API Blueprint på GitHub ved hjælp af forespørgslenlanguage:"API Blueprint".

Medietypen for API Blueprint er text/vnd.apiblueprint, og standardfiludvidelsen er .apib. Hvis du bruger denne udvidelse, vil dine blueprints på GitHub blive syntakseret.

Bygget til bedre API-designs

API Blueprint er bygget til at tilskynde til bedre API-designs gennem abstraktion.Målet med API Blueprint er at afkoble elementer af API’et for at muliggøre modularitet og samtidig indkapsle backend-implementeringsadfærd.

For eksempel skal du først modellere dine data ved hjælp af syntaksen til databeskrivelse.

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

Dernæst skal du bruge og genbruge dataene i dine API-endpoints.

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

Design-først

API Blueprint er baseret på design-først-filosofien. I lighed med test intest-driven udvikling repræsenterer API Blueprint en kontrakt for en API. at diskutere din API og fastlægge kontrakten, før den udvikles, har tendens til at føre til bedre API-designs.

Når din API Blueprint er på plads, kan alle teste, om implementeringen lever op til de forventninger, der er fastsat i kontrakten.

Godt værktøj

Takket være dens brede vedtagelse er der et væld af værktøjer bygget til API Blueprint.Fra forskellige enkeltstående værktøjer såsom mock server, dokumentation og testværktøjer til komplette API livscyklusløsninger.

Se afsnittet Værktøjer for at få en liste.

Gå i gang

For at komme i gang med API Blueprint skal du bruge en almindelig tekst editor. For at få den bedste redigeringsoplevelse skifter du syntaks-highlighting til Markdown eller direkte til API Blueprint (hvis det understøttes af din editor).

Med editor klar kan du følge API Blueprint tutorial.

Når du har skrevet dit første API Blueprint kan du diskutere API-designet med venner og bruge værktøjerne til API Blueprint. For eksempel for at rendere dokumentation, generere en mock af din tjeneste eller begynde at teste din backend-implementering.