Hvordan importere Motimate Public API Dokumentasjon til Insomnia Collection?

Innledning

Hvis du er en API-utvikler, vet du hvor viktig det er å teste og dokumentere applikasjonen din for å sikre dens funksjonalitet og pålitelighet. Postman og Insomnia er populære verktøy blant utviklere da de gir et brukervennlig grensesnitt for å lage HTTP-forespørsler, teste endepunkter og visualisere svar. En av nøkkelfunksjonene til disse verktøyene er muligheten til å importere dokumentasjon i Open API-format. I denne artikkelen vil vi guide deg gjennom prosessen med å importere Motimate Public API-dokumentasjon (i Open API 3.0 format) til en Insomnia-samling, noe som gjør API-testing og utvikling mer effektiv.

Krav

Før vi starter, må du ha Insomnia installert på systemet ditt. Du kan laste ned Insomnia her.

Trinn en: import

1. Åpne Insomnia og klikk på "Opprett"-knappen.
   
   
2. Velg "Importer fra URL"-valget.
   
   
   
   
3. Lag en Insomnia-samling fra URL-en
   
   
4. Skriv inn følgende URL: https://motimate.motimateapp.com/public_api/docs.json
   
   
5. Klikk på "Hent og import"-knappen.
   
   
   
   
6. Velg “Forespørselssamling” når du blir spurt om hvordan du vil importere API-en.
   
   
   
   
7. Insomnia vil informere deg om den vellykkede importen med “Import Succeeded”-dialogen. Klikk “Ok”.
   
   
   
   
8. Samlingen er nå importert. Klikk på den for å se samlingens detaljer.

          Ny samling importert fra dokumentasjonen

Forespørselssamlingsdetaljer. Forespørslene er gruppert i ressurser, som Grupper og Brukere.

Trinn to: autorisasjon

1. Finn POST /oauth/token forespørsel i “Tokens”-seksjonen. Du bør se et svar-legemeeksempel med client_id, client_secret og grant_type.
   
   På venstre side kan du se den valgte forespørselen: POST /oauth/token. På høyre side kan du se et forespørsel-legemeeksempel.
   
   
2. Erstatt client_id og client_secret i svarlegemets eksempel med din egen klient-ID og klienthemmelighet. Hvis du ikke allerede har dem, vennligst kontakt Motimate kundesupport.
   
   
3. Sett grant_type til client_credentials.
   
   
4. Klikk på "Send"-knappen for å sende forespørselen. Svaret du mottar, bør inkludere access_token.
   
   
   
   
5. Nå må du konfigurere samlingens miljø. For å gjøre dette, kan du enten bruke en snarvei (på Mac, trykk Command+E) eller klikke på "OpenAPI env motimateapp.com" og velge "Administrer Miljøer".
   
   
   
   
6. Du burde se en JSON-struktur witch scheme, base_path, host og bearerToken. baererToken tokenverdien er i utgangspunktet satt til "baererToken". Begynn å erstatte den med “response”. En liste over mulige såkalte “functions” burde vises. Velg “Response ➔ Body Attribute”.
   
   
   
   
7. For å konfigurere funksjonen, klikk på den røde taggen som indikerer at konfigurasjonen er ufullstendig. Dette vil føre til at "Edit Tag"-vinduet blir vist.
   
   
   Rød tagg som indikerer at en funksjon er ufullstendig
   
   Rediger tagg vindu
   
   
8. Fyll ut skjemaet som vist nedenfor:

      9. Utfylt Rediger Tagg-skjema. Merk deg tilgangstokenet synlig i Live Preview-seksjonen.

    10. Klikk “Ferdig”. Den tidligere røde taggen som representerte bearerToken din burde nå være                            erstattet med en grønn en med tittelen “Response ➔ Body Attribute”.

     11. NB! Ikke klikk på “Lukk”-knappen med en gang. Insomnia vil ikke huske endringene                         du nettopp har gjort! I stedet, klikk hvor som helst på skjermen først, og deretter klikk på “Lukk”                         knappen.

     12. Nå kan du teste konfigurasjonen din. Den beste måten å gjøre dette på er å sende en GET /me forespørsel                 (fra “Me”-seksjonen). Hvis du ser organisasjonsdataene dine i svaret, gratulerer - du har klart å importere Motimate Public API-dokumentasjon!