Kai jūs pažeidžiate API be įspėjimo, jūs pažeidžiate pasitikėjimą 
 
 TL;DR: turėtumėte versijuoti savo API, kad nebūtų pažeisti esami klientai, kai atliekate pakeitimus. TL;DR: turėtumėte versijuoti savo API, kad nebūtų pažeisti esami klientai, kai atliekate pakeitimus. Problemos 
 
 
 
 
 
 
 
 
 Kliento programų žlugimas Integracijos nesėkmės Mažiausios staigmenos principo pažeidimas Poilsio laikas Pažeistas pasitikėjimas Reikalingi rollbacks Plėtoti laiką Naudotojo patirties degradacija Sprendimai 
 
 
 
 
 
 
 
 
 
 
 
 
 Pridėti semantinę versiją Atgalinės suderinamumo įdiegimas Sukurti depreciacijos įspėjimus Kuriame kelio žemėlapius Naudokite turinio derybas Paralelinės versijos Anksti praneškite apie pokyčius Palaipsniui išnyksta savybės Dokumento pažeidimas keičiasi aiškiai Patikrinkite deprecated parametrus su logging Išsamiai išbandykite naujas versijas Pašalinti sutrikusią funkciją po saulėlydžio Kontekstas Kai modifikuojate API be tinkamos versijos, sukuriate keitimus, kurie turi įtakos visiems esamiems klientams. Jūs verčiate vartotojus nedelsiant atnaujinti savo kodą arba susidurti su sistemos gedimais. Jūs pažeidžiate numanomą sutartį tarp API teikėjų ir vartotojų. Šiuolaikinė programinė įranga labai priklauso nuo API stabilumo, ir be įspėjimo įvedus pažeidžiančius pakeitimus gali atsirasti kaskadinių gedimų priklausomose sistemose. Šiandien tai svarbiau nei bet kada . daugelis IA kuria savo sprendimus, naudojant esamą API dokumentaciją Kai atnaujinate API nepalaikydami atgalinio suderinamumo, rizikuojate nutraukti visas nuo jo priklausomas programas. Tai sukuria nestabilumą, nusivylimą ir brangius taisymus vartotojams. Dažnai pacientai toleruoja Naujose funkcijose, bet niekada anksčiau stabilus elgesys sulaužytas. Defektų Tinkama versija užtikrina sklandžius perėjimus ir palaiko jūsų sistemos patikimumą. Pavyzdinis kodas Neteisinga 🙂 // 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;
  });
 Teisinga 🙂 // 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;
  });
 Aptikimas 
 
 [x] pusiau automatinis Galite aptikti šį kvapą, kai rasite API, kurie keičia laukų pavadinimus, pašalina laukus arba keičia duomenų struktūras, išlaikydami atgalinį suderinamumą. Ieškokite klientų programų, kurios nutrūksta po API diegimo. Patikrinkite trūkstamas versijos antraštes arba URL versijos schemas. Stebėkite klaidų žurnalus dėl staigių kliento gedimų po išleidimo. Dienos ️ 
 
 APIS Lygis 
 
 [x] Tarpinė Kodėl tai svarbu ️ Turite išlaikyti stabilų tarp jūsų API sutarties ir klientų lūkesčių. Žemėlapis Kai tai sulaužysite keisdami API be versijos, pažeidžiate pagrindinį principą, kad klientai gali pasikliauti nuosekliomis sąsajomis. Bijecija Jūs sukuriate neatitikimą tarp to, ką klientai tikisi gauti ir ką suteikia jūsų API. Tai nutraukia vieno su vienu atitikimą tarp API pažadų ir API pristatymo, dėl to atsiranda sistemos gedimų ir pasitikėjimo praradimas. APIs modeliuoja realaus pasaulio paslaugas.Kai nutraukiate savo API ir jo verslo logikos supratimą, klientai negali patikimai bendrauti su jūsų sistema. Šis neatitikimas lemia trūkumus, neveikimo laiką, pasitikėjimo trūkumą ir prastą vartotojo patirtį. Šios kartos AI generatoriai dažnai sukuria šį kvapą, kai paprašysite jų "patobulinti" arba "atnaujinti" esamus API. Jie orientuojasi į tai, kad API būtų „geresnis“, neatsižvelgiant į atgalinį suderinamumą. Jūs turite aiškiai nurodyti AI įrankius išlaikyti esamus laukų pavadinimus ir pridėti versiją, kai atliekami pakeitimai. Jie dažnai teikia pirmenybę švariam dizainui, išskyrus atvejus, kai Sakė kitaip. Aiškiai Detektorius AI generatoriai gali ištaisyti šį kvapą, kai pateikiate aiškias instrukcijas apie API versijos strategijas. Turėtumėte paprašyti jų įgyvendinti semantinę versiją, išlaikyti atgalinį suderinamumą ir sukurti migracijos kelius išnykusioms funkcijoms. Išbandykite juos! Atminkite: AI padėjėjai daro daug klaidų 
 
 Siūlomas nurodymas: sukurkite API versiją, kad išvengtumėte pakeitimų pažeidimo Siūlomas nurodymas: sukurkite API versiją, kad išvengtumėte pakeitimų pažeidimo 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 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 Šaulys Šaulys Klodas Klodas Susirūpinimas Susirūpinimas Vaikų pilotas Vaikų pilotas Dvyniai Dvyniai DeepSeek DeepSeek Tikslas AI Tikslas AI Grožinė Grožinė Kėdainiai Kėdainiai Išvada Visada turėtumėte versijuoti savo API, kad išvengtumėte kliento programų pakeitimų. Net ir nuo pirmosios versijos. Kai išlaikysite stabilias sutartis per tinkamą versiją, sukursite pasitikėjimą su API vartotojais ir užtikrinsite sklandų savo sistemų evoliuciją. Pokyčiai yra neišvengiami, tačiau jie neturėtų sugadinti jūsų klientų. Visada versijuokite savo API, atsargiai atsisakykite ir aktyviai bendraukite, kad išvengtumėte nereikalingų sutrikimų. Bendravimas 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 Kodų kvapai yra mano . Nuomonė Kreditas Nuotrauka iš yra Giancarlo Revolledo nuotr. Nesėkmė 
 
 API yra amžini, todėl juos projektuokite atsargiai API yra amžini, todėl juos projektuokite atsargiai Martinas Fowleris https://hackernoon.com/400-thought-provoking-software-engineering-quotes?embedable=true Šis straipsnis yra CodeSmell serijos dalis. 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

Šis garso įrašas sukurtas originalia istorijos kalba!

Per ilgai; Skaityti

Make resilience your competitive advantage

Kodo kvapas 303 - kaip užkirsti kelią esamų klientų pažeidimui, kai atliekate pakeitimus

Kodo kvapas 303 - kaip užkirsti kelią esamų klientų pažeidimui, kai atliekate pakeitimus

About Author

KOMENTARAI

PABAIGTI ŽYMES

ŠIS STRAIPSNIS BUVO PRISTATYMAS

Related Stories

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps