Kada razbijete API-je bez upozorenja, razbijete povjerenje 
 
 TL;DR: Trebali biste da verzišete svoje API-je kako biste spriječili slom postojećih klijenata kada napravite promene. TL;DR: Trebali biste da verzišete svoje API-je kako biste spriječili slom postojećih klijenata kada napravite promene. Problemi 
 
 
 
 
 
 
 
 
 Klijent aplikacije crashes Neuspeh integracije Kršenje principa najmanje iznenađenja Dolazak Slomljeno poverenje Potrebni rollbacks za ugradnju Potrošeno vreme za razvoj Degradacija korisničkog iskustva Rešenja 
 
 
 
 
 
 
 
 
 
 
 
 
 Dodavanje semantičke verzije Uvođenje retroaktivne kompatibilnosti Stvaranje upozorenja o deprecijaciji Stvaranje Roadmapa Koristite sadržaj pregovaranja Održavanje paralelnih verzija Ranije obavijestite o promjenama Postupno smanjite karakteristike Dokument koji prelomi promene jasno Provjerite deprecated parametre sa loggingom Test nove verzije temeljito Uklanjanje deprecirane funkcionalnosti nakon zalaska sunca Kontekst Kada modificirate API-je bez pravilnog izdavanja verzija, kreirate promene koje utiču na sve postojeće klijente. Prisiljavate potrošače da odmah ažuriraju svoj kod ili se suočavaju sa sistemskim kvarovima. Prekršite implicitni ugovor između pružatelja API-ja i potrošača. Moderan softver uvelike se oslanja na stabilnost API-ja, a uvođenje promjena bez upozorenja može stvoriti kaskadne neuspehe u zavisnim sistemima. To je danas važnije nego ikad od tada . mnoge IA grade svoja rešenja koristeći postojeće API dokumentacije Kada ažurirate API bez održavanja retroaktivne kompatibilnosti, rizikujete da prekinete sve aplikacije koje ovise o njemu. To stvara nestabilnost, frustracije i skupe popravke za korisnike. Ljudi često toleriraju u novim funkcionalnostima, ali nikada prethodno stabilno ponašanje nije prekinuto. Nedostaci Pravilna verzija osigurava glatke tranzicije i održava pouzdanost vašeg sustava. Sample kod Pogrešno 🙂 // user-api-v1.json - Original API response
{
  "id": 317,
  "name": "Mr Nimbus",
  "email": "nimbus@atlantis.com",
  "nationalities": "Brazilian,Canadian,Oceanic"
}

// Later changed to this without versioning:
{
  "userId": 317,
  "fullName": "Mr Nimbus", 
  "emailAddress": "nimbus@atlantis.com",
  "createdAt": "2018-12-09T18:30:00Z",
  "nationalities": ["Brazilian", "Canadian", "Oceanic"]
}

fetch('/api/users/317')
  .then(response => response.json())
  .then(user => {
    // This breaks when API changes field names and data types
    document.getElementById('name').textContent = user.name;
    document.getElementById('email').textContent = user.email;
    // This breaks when nationalities changes from string to array
    document.getElementById('nationalities').textContent 
      = user.nationalities;
  });
 Right 👉 // user-api-v1.json - Version 1 (maintained)
{
  "id": 317,
  "name": "Mr Nimbus",
  "email": "nimbus@atlantis.com",
  "nationalities": "Brazilian,Canadian,Oceanic"
}

// user-api-v2.json - Version 2 
// (new structure, backward compatible)
{
  "id": 317,
  "userId": 317,
  "name": "Mr Nimbus",
  "fullName": "Mr Nimbus",
  "email": "nimbus@atlantis.com",
  "emailAddress": "nimbus@atlantis.com",
  "createdAt": "2018-12-09T18:30:00Z",
  "nationalities": "Brazilian,Canadian,Oceanic"
  "nationalitiesList": ["Brazilian", "Canadian", "Oceanic"]
}

// user-api-v3.json - Version 3 
// (new structure, backward not compatible)
{
  "userId": 317,
  "fullName": "Mr Nimbus",
  "emailAddress": "nimbus@atlantis.com",
  "createdAt": "2018-12-09T18:30:00Z",
  "nationalitiesList": ["Brazilian", "Canadian", "Oceanic"]
}

// client-code-versioned.js
const API_VERSION = 'v1';

fetch(`/api/${API_VERSION}/users/317`)
  .then(response => response.json())
  .then(user => {
    document.getElementById('name').textContent = user.name;
    document.getElementById('email').textContent = user.email;
    // V1 handles comma-separated string
    document.getElementById('nationalities').textContent
      = user.nationalities;
  });

// Or with content negotiation
fetch('/api/users/317', {
  headers: {
    'Accept': 'application/vnd.api+json;version=1'
  }
})
  .then(response => response.json())
  .then(user => {
    document.getElementById('name').textContent = user.name;
    document.getElementById('email').textContent = user.email;
    document.getElementById('nationalities').textContent 
      = user.nationalities;
  });
 Detekcija 
 
 [x] Poluautomatski Ovaj miris možete otkriti kada pronađete API-je koji mijenjaju imena polja, uklanjaju polja ili mijenjaju strukturu podataka bez održavanja retroaktivne kompatibilnosti. Potražite aplikacije klijenta koje se prekidaju nakon implementacije API-ja. Provjerite da li nedostaju naslovi verzija ili sheme za verziju URL-a. Praćenje dnevnika grešaka za iznenadne pike u neuspjehu klijenta nakon izdavanja. U toku dana ️ 
 
 Apis Nivo 
 
 [x] Posrednik Zašto je bijecija važna ️ Potrebno je održati stabilan između vašeg API ugovora i očekivanja klijenata. Mapa Kada razbijete ovo promjenom API-ja bez verziranja kršite temeljni princip da se klijenti mogu osloniti na dosljedne sučelje. Bijecija You create a mismatch between what clients expect to receive and what your API provides. To prekida jedan-na-jedan korespondenciju između API obećanja i API isporuke, što dovodi do neuspjeha sistema i gubitka poverenja. Kada prekinete mapiranje između vašeg API-ja i poslovne logike koju predstavlja, klijenti ne mogu pouzdano komunicirati sa vašim sistemom. Ova neusklađenost dovodi do nedostataka, prekida vremena, nedostatka poverenja i lošeg korisničkog iskustva. Ova generacija AI generatori često stvaraju ovaj miris kada ih zamolite da "izboljeđuju" ili "aktualiziraju" postojeće API-je. Oni se fokusiraju na to da API bude "bolji" bez razmatranja retroaktivne kompatibilnosti. Potrebno je eksplicitno uputiti AI alate za održavanje postojećih imena polja i dodati verziju prilikom izrade promena. Često preferiraju čisti dizajn u odnosu na stabilnost, osim ako Rekli su drugačije. Eksplicitno Detekcija AI generatori mogu popraviti ovaj miris kada pružite jasne upute o strategijama za verziju API-ja. Trebali biste ih zamoliti da implementiraju semantičko verzijiranje, održavaju retroaktivnu kompatibilnost i kreiraju migracijske staze za deprecirane funkcije. Isprobajte ih! Zapamtite: AI asistenti čine mnogo grešaka 
 
 Predložen prompt: Kreirajte verziju API-ja kako biste sprečili prelom promena Predložen prompt: Kreirajte verziju API-ja kako biste sprečili prelom promena 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 Without Proper Instructions 
 With Specific Instructions 
 
 
 
 ChatGPT 
 ChatGPT 
 
 
 
 Claude 
 Claude 
 
 
 
 Perplexity 
 Perplexity 
 
 
 
 Copilot 
 Copilot 
 
 
 
 Gemini 
 Gemini 
 
 
 
 DeepSeek 
 DeepSeek 
 
 
 
 Meta AI 
 Meta AI 
 
 
 
 Grok 
 Grok 
 
 
 
 Qwen 
 Qwen Čačak Čačak Klod Klod zbunjenost zbunjenost Piloti Piloti Blizanci Blizanci duboko duboko Cilj AI Cilj AI Grožđe Grožđe Knjiga Knjiga Zaključak Uvek treba da verzišete svoje API-je kako biste sprečili da promene utječu na aplikacije klijenta. Čak i od vaše prve verzije. Kada održavate stabilne ugovore kroz pravilno izdavanje verzija, gradite povjerenje sa potrošačima API-ja i omogućite glatku evoluciju vaših sistema. Promene su neizbežne, ali ne bi trebale slomiti vaše klijente. Uvek verzišite svoje API-je, pažljivo deprecate i proaktivno komunicirajte kako biste izbegli nepotrebne poremećaje. Odnosi https://hackernoon.com/misusing-http-status-codes-wrecks-your-api-monitoring-and-client-logic https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-iv-7sc3w8n https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xii https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xxii https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xxxiv https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xxxv Disclaimer Mirisi su moji . Mišljenje Krediti Fotografije od je Đancarlo Revolledo Uslovi 
 
 API-ji su zauvijek, pa ih pažljivo dizajnirajte API-ji su zauvijek, pa ih pažljivo dizajnirajte Džordž Fowler https://hackernoon.com/400-thought-provoking-software-engineering-quotes?embedable=true Ovaj članak je deo CodeSmell serije. https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-i-xqz3evd?embedable=true

Winner of Noonies 2020 for the award Hacker Noon Contributor of the Year - REFACTORING.

2020 - Hacker Noon Contributor of the Year in REFACTORING

2022 - HackerNoon Contributor of the Year - Clean Code

2022 - HackerNoon Contributor of the Year - Debugging

2022 - HackerNoon Contributor of the Year - Github

2022 - HackerNoon Contributor of the Year - Machine Learning

2022 - HackerNoon Contributor of the Year - Quality Assurance

2022 - HackerNoon Contributor of the Year - Refactoring

2022 - HackerNoon Contributor of the Year - Software Architecture

2022 - the Greatest Storyteller

Buy My Book

Share your ideas with me!

Read My Stories

Buy Me a Coffee

Software Engineer and Book Author

Ovaj audio je proizveden na originalnom jeziku priče!

Predugo; Citati

Make resilience your competitive advantage

Code Smell 303 - Kako sprečiti razbijanje postojećih klijenata kada napravite promene

Code Smell 303 - Kako sprečiti razbijanje postojećih klijenata kada napravite promene

About Author

KOMENTARI

HANG TAGS

OVAJ ČLANAK JE PREDSTAVLJEN U

Related Stories

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps