Læs API-dokumentation med AI

En endpoint-post angiver URL'en, HTTP-metoden, påkrævede og valgfrie parametre samt et eksempel på et svar. Disse fire dele er alt, hvad du behøver for at kalde den.

Hvis en post virker tæt pakket, kan du indsætte den i din assistent og bede den mærke hver del, så strukturen bliver tydelig ved første øjekast.

Parametre tilpasser en anmodning. Påkrævede parametre skal være med, ellers mislykkes kaldet; valgfrie parametre justerer resultatet, f.eks. sidestørrelse eller sprog.

Dokumentation markerer normalt, hvad der er hvad. Bed først din assistent om kun at liste de påkrævede parametre, så du kan få et grundlæggende kald til at virke, før du tilføjer ekstra parametre.

Dokumentation beskriver altid, hvordan du godkendes. Nogle API'er kræver en API-nøgle i en header, mens andre bruger et token eller en forespørgselsparameter. Hvis du gør dette forkert, returnerer hvert kald 401.

Det er let at skimme hen over dette afsnit. Bed din assistent udtrække det nøjagtige header- eller parameternavn, som dine anmodninger skal indeholde.

Dokumentation indeholder eksempelsvar, så du kender datastrukturen, før du foretager kaldet. Det viser, hvilke felter der findes, og hvordan de er indlejret.

Når du kender strukturen, kan du planlægge din kode. Du kan bede din assistent knytte eksemplet til de nøjagtige variable, som din skærm skal vise.

API'er ændrer sig med tiden, så dokumentationen er versionsinddelt, f.eks. v1 eller 2024-01-01. Hvis du bruger eksemplet fra en gammel version mod et nyt endpoint, opstår der uoverensstemmelser.

Kontrollér, at du læser den version, der passer til den URL, du kalder. Din assistent kan gøre opmærksom på, når et eksempel ser forældet ud i forhold til det endpoint, du retter dig mod.

Mange dokumentationer tilbyder en interaktiv "prøv det"-konsol, hvor du indtaster parametre og foretager et rigtigt kald i browseren. Det er den hurtigste måde at bekræfte, at en anmodning virker.

Brug den til at validere parametre, før du skriver kode. Bed derefter din assistent om at oversætte det fungerende konsolkald til sproget i din app.

List-endpoints returnerer sjældent alt på én gang. De bruger sideinddeling og giver dig én side ad gangen samt et token eller et sidetal til den næste portion.

Dokumentationen forklarer ordningen for sideinddeling. Bed din assistent læse den og skrive en lille løkke, der henter alle sider sikkert uden at overskride hastighedsgrænserne.

Det virkelige stærke træk er at give dokumentationen direkte til din assistent og bede om fungerende kode med kommentarer. Du slipper for at prøve dig frem.

Medtag altid dokumentationslinket eller den indsatte tekst, dit sprog og dit mål. Specifik kontekst giver langt oftere kode, der kører første gang.

AI kan misforstå dokumentation eller antage en parameter. Kør altid det genererede kald, og sammenlign resultatet med dokumentationens eksempelsvar.

Hvis noget ikke stemmer, skal du indsætte fejlen og det relevante dokumentationsafsnit i din assistent igen. Når du itererer med konkrete beviser, løser du integrationsfejl hurtigt.

Dokumentation indeholder endpoints, parametre, godkendelse, eksempelsvar, versioner og sideinddeling. Start med quickstarten, og gå derefter i dybden med den post, du har brug for.

Giv afsnit til din AI-assistent for at få opsummeringer i almindeligt sprog og klar kode, men verificér altid mod eksempelsvaret. Derefter foretager du dit første rigtige kald.