TL; DR version

I et af de tidligere indlæg diskuterede vi kort fortalt, hvordan det er at bruge GitHub API v3. Denne version er designet til at være grænseflader som enhver anden REST API. Der er slutpunkter for hver ressource, som du har brug for for at få adgang til og / eller ændre. Der er slutpunkter for hver bruger, hver organisation, hvert arkiv og så videre. For eksempel har hver bruger sit API-slutpunkt på https: // api.github.com / brugere / du kan prøve at erstatte dit brugernavn i stedet for og indtast URL'en i en browser for at se, hvad API'en reagerer med.

GitHub API v4 bruger derimod GraphQL, hvor QL står for Query Language. GraphQL er en ny måde at designe dine API'er på. Ligesom der er mange webtjenester, der tilbydes som REST API'er, ikke kun dem, der tilbydes af GitHub, er der mange webtjenester, der giver dig mulighed for at grænseflade med dem via GraphQL.

Den stærkeste forskel, du vil bemærke mellem GraphQL og REST API, er, at GraphQL kan fungere ud fra et enkelt API-slutpunkt. I tilfælde af GitHub API v4 er dette slutpunkt https: // api.github.com / graphql og det er det. Du behøver ikke bekymre dig om at tilføje lange strenge i slutningen af ​​en root-URI eller angive en forespørgselsstrengparameter for ekstra information. Du sender simpelthen et JSON-lignende argument til denne API og beder kun om de ting, du har brug for, og du får en JSON-nyttelast tilbage med nøjagtig den samme information, som du har anmodet om. Du behøver ikke beskæftige dig med at filtrere uønskede oplysninger ud eller lide af performance overhead på grund af store svar.

Hvad er REST API?

Nå, REST står for Representational State Transfer og API står for Application Programming Interface. En REST API eller en 'RESTful' API er blevet den centrale designfilosofi bag de fleste moderne klient-server applikationer. Idéen fremgår af behovet for at adskille forskellige komponenter i en applikation som klientsiden UI og serversides logik.

Så sessionen mellem en klient og en server er typisk statsløs. Når websiden og relaterede scripts er indlæst, kan du fortsætte med at interagere med dem, og når du udfører en handling (som at trykke på en sendeknap), sendes en sendeanmodning sammen med alle de kontekstuelle oplysninger, som webserveren har brug for til at behandle den anmodning ( som brugernavn, tokens osv.). Applikationen overgår fra en tilstand til en anden, men uden et konstant behov for forbindelse mellem klienten og serveren.

REST definerer et sæt begrænsninger mellem klienten og serveren, og kommunikationen kan kun ske under disse begrænsninger. For eksempel bruger REST over HTTP normalt CRUD-modellen, som står for Opret, læse, opdatere og slette og HTTP-metoder som POST, GET, PUT og DELETE hjælper dig med at udføre disse operationer og disse operationer alene. Gamle indtrængningsteknikker som SQL-injektioner er ikke en mulighed med noget som en tæt skrevet REST API (selvom det er REST, er det ikke et sikkerhedsmiddel).

Det hjælper også UI-udviklere ret meget! Da alt, hvad du modtager fra en HTTP-anmodning, typisk er en strøm af tekst (formateret som JSON, nogle gange), kan du nemt implementere en webside til browsere eller en app (på dit foretrukne sprog) uden at bekymre dig om serversides arkitektur. Du læser API-dokumentationen for tjenester som Reddit, Twitter eller Facebook, og du kan skrive udvidelser til dem eller tredjepartsklienter på det valgte sprog, da du er garanteret, at API'ens opførsel stadig vil være den samme.

Omvendt er serveren ligeglad med, om front-end er skrevet i Go, Ruby eller Python. Uanset om det er en browser, app eller en CLI. Det 'bare' ser anmodningen og svarer passende.

Hvad er GraphQL?

Som med alt andet inden for computeren blev REST API'er større og mere komplekse, og på samme tid ville folk implementere og forbruge dem på en hurtigere og enklere måde. Dette er grunden til, at Facebook kom op med ideen om GraphQL og senere åbnede den. QL i GraphQL står for Query Language.

GraphQL giver klienter mulighed for at foretage meget specifikke API-anmodninger i stedet for at foretage stive API-opkald med foruddefinerede parametre og svar. Det er meget mere simpelt, fordi serveren derefter reagerer med nøjagtigt de data, som du bad om, uden noget overskud.

Se på denne REST-anmodning og dens tilsvarende svar. Denne anmodning er beregnet til kun at se en brugers offentlige biografi.