Specifikacija API-ja je novija od modela

Primer koda iz sećanja može učiniti izmenu kupca jednostavnom. U ovom ilustrativnom slučaju agent je piše iz memorije. Ime metode zvuči ubedljivo. Polja su poznata. Testni podaci prihvataju zahtev. Stvarna specifikacija dobavljača se promenila posle nastanka primera.

Greška je počela pre poziva. Agent je koristio memoriju tamo gde je trebalo da koristi aktuelan izvor.

Rasprava o agentima i promenljivim API-jima zalaže se za preuzimanje tačnog odlomka koji odgovara na zadatak. Ovo načelo je posebno korisno u integracijama, gde je definicija API-ja promenljiva tehnička specifikacija, a ne samo dodatna literatura.

Ubedljiv poziv nije specifikacija

Veliki modeli uče iz koda, dokumentacije i rasprava nastalih u različito vreme. Primeri mogu ostati korisni za oblik i način pisanja. Ne mogu utvrditi šta dobavljač prihvata danas, u verziji koju aplikacija koristi, na nalogu povezanom sa sinhronizacijom.

Shopify vodič za verzije API-ja dokumentuje tromesečni raspored izdanja i napomene o promenama po verzijama. Programer može izabrati podržanu verziju, pa pročitati promene relevantne za nadogradnju. Verzija u zahtevu je važnija od modelovog sećanja na „Shopify API“.

Brevo referenca za stvaranje kontakta dodaje još jedan sloj: prilagođeni atributi moraju postojati u nalogu, a vrednosti koje ne odgovaraju deklarisanom tipu mogu biti zanemarene. Opšta API šema agentu ne govori koje je atribute baš ovaj nalog stvorio. Za to treba upit ili provera ograničena na nalog.

Trenutna specifikacija ima najmanje dva dela: objavljenu operaciju dobavljača i podešene objekte naloga. Agentu trebaju oba kada zadatak zavisi od oba.

Verzija i opseg naloga treba da prate preuzeti odgovor. Tačan opis operacije za jednu verziju API-ja može biti pogrešan za drugu. Tačno ime atributa u jednom Brevo nalogu možda ne postoji u drugom. Izabranu verziju i identifikator naloga uključite u testni primer i zaustavite ga ako je bilo šta nepoznato. Pomoćnik ne treba da razreši tu nejasnoću nagađanjem iz sličnog primera.

Preuzmite mali deo koji koristite

Loša popravka je da u svaki korak agenta nalepite deset hiljada definicija operacija. Model tada ima više teksta za pretragu, više zastarelih odlomaka za mešanje i manje mesta za stvarni zadatak. Tražite operaciju koja pomera ovaj zapis i ograničenja koja određuju njen uspeh.

Za izmenu kontakta potreban materijal može biti put operacije, dozvoljena polja, obavezan identifikator, pravila tipova atributa i trenutna verzija API-ja. Dajte agentu te odlomke sa vezama ka izvorima. Ostatak neka ostane dostupan za drugo pitanje.

Tajo vodič za Brevo API pomaže čitaocu da se snađe kod dobavljača. Precizan poziv treba da potvrdi zvanična referenca pre upotrebe u produkcionom kodu. Čitaocu treba izvor koji može ponovo otvoriti kada dobavljač nešto promeni.

Repozitorijum može učiniti postupak ponovljivim. Zabeležite vezanu verziju, heš sačuvane specifikacije i datum provere. Promenjen heš ne dokazuje nekompatibilnu promenu; pokazuje održavaocu šta da uporedi. Model može sažeti relevantnu razliku. Testovi ipak treba da pokrenu operacije od kojih zavisi radna sinhronizacija.

Generisani zahtev tretirajte kao hipotezu sa tri provere. Prvo, da li se slaže sa zvaničnom operacijom i vezanom verzijom? Drugo, da li povezani nalog sadrži objekte koje zahtev pretpostavlja? Treće, da li ograničeno izvršavanje ostavlja očekivano stanje? Provera šeme odgovara na prvo, upit nalogu na drugo, a upis i ponovno čitanje na treće. Nijedno ne zamenjuje druga dva.

1. Operacija dobavljača verzija · polja

   Šta objavljeni API prihvata

   sužava
2. Povezani nalog atribut · tip

   Šta postoji u ovom nalogu

   sužava
3. Ograničeno izvršavanje upis · ponovno čitanje

   Šta se stvarno promenilo

Preuzimanje nije dokaz izvršenja

Pošten prigovor je: „Zvanična dokumentacija može kasniti za živom uslugom.“ Može. Čitanje je nužno, ali nedovoljno. Test prema specifikaciji treba da pošalje ograničen zahtev kroz isti klijentski kod i proveri odgovor i stanje odredišta. Ako se usluga ponaša drugačije, zabeležite razliku i ograničite pogođenu operaciju.

Agent treba i da stane kada je specifikacija nejasna. Pogađano mapiranje polja primenjeno na mnogo kontakata skuplje je od jednog pregleda definicije. Vodič za integraciju više poslovnih alata počinje izborom izvora istine za svaki podatkovni objekat; aktuelnost API-ja je ista disciplina primenjena na operacije koje objekat pomeraju.

Cena je održavanje aktuelnih referenci i testova. Alternativa je plaćanje iste zastarele pretpostavke na svakom zapisu koji sinhronizacija dotakne.

Model može zapamtiti ideju. Mora pročitati specifikaciju i proveriti nalog koji namerava da menja.

To ne mora usporiti svaku interakciju. Sačuvajte uski odlomak vezan za verziju i šemu naloga do poznatog događaja koji ih poništava ili izabrane tačke za osveženje. Uz odluku sačuvajte izvor i datum preuzimanja. Cena novog čitanja plaća se kada se specifikacija možda promenila, ne za svaki ponovljeni red već odobrene sinhronizacije.