Ukusetshenziswa okungenani kwe-query parameters kubaluleke ukuphathwa kwe-API 
 
 TL;DR: Usebenzisa izindlela ze-URL noma ama-header ye-API ye-versioning. TL;DR: Usebenzisa izindlela ze-URL noma ama-header ye-API ye-versioning. Izinzuzo 62 
 
 
 
 
 
 
 
 
 
 
 
 Ukuhlobisa Parameters Ukuvikelwa High inguqulelo Imibuzo ye-Customer Imibuzo emibi I-Incompatibility ye-Background I-URL ye-clutter Ukukhangisa Complexity Ukulungiselela Semantics Parameter Ukuhlobisa Ukuhlobisa Izimo izixazululo 62 
 
 
 
 
 
 
 Izindlela ze-URL Ukukhangisa Parameters Ukubuyekeza Headers Imininingwane ye-Breaking Changes Hlola i-versions ezidlulileyo Ukuhlobisa ama-versions ezidlulileyo ngokufanele Umhlahlandlela Uma ukuguqulwa i-API ngokuvamile Izixhumi ezidlulayo, uzothola imibuzo. Ukuhlobisa Ukuze ukunceda lokhu, kufanele ukulayisha API yakho. I-Versioning inikezela ukongeza izici ezintsha noma ukuguqulwa kwamakhemikhali ngaphandle kokugcina amakhasimende ezidlulile ukusebenza. Ngokuvamile, uthathe inombolo ye-version ku-API URL path, i-HTTP headers, noma, okungenani kakhulu, ku-query parameters. Konke indlela inezinzuzo kanye nezinzuzo. Ukuguqulwa kwe-URL path kuyinto elula futhi etholakalayo. Ukuguqulwa kwe-Header ivimbela i-URL emangalisayo kodwa ivimbela ukucindezeleka. I-Query Parameters ingathanda i-URL futhi ingathanda. Isebenzisa i-versioning kuphela ukuhlangabezana izinguqulo. Ukuphathwa kwezinguqulo ezingu-versions kuncike umsebenzi wokuphepha kodwa kuncike ukuzinza kanye nokuphepha kwamakhasimende. Sample Ikhodi Ngena ngemvume <?php

// Misusing query parameters for versioning
// https://eratostenes.com/api/primes?limit=10&version=2
// Version 2 is faster!

$version = $_GET['version'] ?? '1';

if ($version === '1') {
    echo json_encode(['data' => 'Response from API v1']);
} elseif ($version === '2') {
    echo json_encode(['data' => 'Response from API v2']);
} else {
    http_response_code(400);
    echo json_encode(['error' => 'Unsupported API version']);
}

// This handling with IF/Switches is another code smell
 Ngena ngemvume <?php 
// https://eratostenes.com/api/v2/primes?limit=10
// NOTICE                     /V2/
// Version 2 is faster!

$requestUri = $_SERVER['REQUEST_URI'];

if (preg_match('#^/v([0-9]+)/#', $requestUri, $matches)) {
    $version = $matches[1];
} else {
    $version = '1';  
}

switch ($version) {
    case '1':
        echo json_encode(['data' => 'Response from API v1']);
        break;
    case '2':
        echo json_encode(['data' => 'Response from API v2']);
        break;
    default:
        http_response_code(400);
        echo json_encode(['error' => 'Unsupported API version']);
}
 <?php
// Header-based API versioning example

// GET /api/primes?limit=12 HTTP/1.1
// Host: eratostenes.com
// Accept: application/vnd.myapi.v2+json
// NOTICE THE HEADER             V2  

$acceptHeader = $_SERVER['HTTP_ACCEPT'] ?? '';

if (preg_match('#application/vnd\.myapi\.v(\d+)\+json#', 
    $acceptHeader, $matches)) {
    $version = $matches[1];
} else {
    $version = '1';  
}

switch ($version) {
    case '1':
        echo json_encode(['data' => 'Response from API v1']);
        break;
    case '2':
        echo json_encode(['data' => 'Response from API v2']);
        break;
    default:
        http_response_code(400);
        echo json_encode(['error' => 'Unsupported API version']);
}
 Ukubuyekezwa 
 
 [x] Ukuhlobisa Ungathola i-odor lapho ama-endpoints akho zihlanganisa . inguqulo = 1 I-Linters ne-API design reviews ingathola ama-parameters asetshenziselwa ukulayishwa kwe-versioning. Ungathola lokhu ukuphazamiseka uma ufake amakhasimende ngemuva kokuguqulwa kwe-API noma ukuguqulwa kwe-version iyahambisana. Thola ukusetshenziswa kwezinhlayiyana ze-query ukucacisa izinguquko noma izindlela eziningana nezidokumented. Qinisekisa ukuthi izinguquko ezidlulileyo zihambisana kodwa akuyona ngokuvamile noma akubhalwe. Usuku ️ 
 
 Imininingwane izinga 
 
 [x] I-Intermediate Yintoni i-bijection iyona ebalulekile ️ API version kufuneka map Ukubuyekezwa kwe-Domain Model yakho Ukubuyekezwa Uma uthathe i-versions ye-non-breaking changes, uthatha lokhu futhi ukudala ukuhlangabezana mayelana nemingcele esibonakalayo. Umhlahlandlela Lokhu kuholele ku-version spreadl, lapho amakhasimende awukwazi ukucacisa ukuthi inguqulo esithakazelisayo, okwenza i-API yakho engaphakathi nokupholisa. Uma izinguquko ze-API zihlanganisa ngokuvamile nezivumelwano zokusebenzisa, amakhasimende bayazi ukuthi idatha kanye nokuthuthukiswa kungenzeka. Ukuqhathanisa le-one-to-one mapping ngokuguqulwa kokusebenza kwe-API ngaphandle kokuguqulwa kwe-versioning kusenza ukulondoloza kwamakhasimende nama-runtime errors. I-Clear versioning iveza lokhu Okuzenzakalelayo futhi owaziwa. Ukuhlobisa Imininingwane I-AI generators ingakwazi ukwenza ikhodi nge-inconsistent noma ngaphandle kwe-API versioning, ikakhulukazi uma kubhalwe izibonelo amancane. I-AI generators ikhiqiza ama-endpoints e-rapid-and-dirty nge-query parameters. Zihlanganisa ngesivinini, akuyona semantics. Ukubuyekezwa Izinsiza ze-AI zingathola okuhlobene ngokuhlola imibala ze-endpoint, ukuguqulwa kwezinhlobonhlobo zokuphendula phakathi kwezinhlobonhlobo, nokuvumelana nezinhlobonhlobo ezincinane phakathi kwezinhlobonhlobo ze-API. Zibonisa ukuguqulwa kwezinguquko ezingenalutho ku-versions ezidlulayo. Thola kwabo! Qiniseka: I-AI Assistants ikhiqiza imiphumela eminingi 
 
 I-Suggested Prompt: Ukusebenzisa izinguquko ze-API ku-URL I-Suggested Prompt: Ukusebenzisa izinguquko ze-API ku-URL 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 Without Proper Instructions 
 With Specific Instructions 
 
 
 
 ChatGPT 
 ChatGPT 
 
 
 
 Claude 
 Claude 
 
 
 
 Perplexity 
 Perplexity 
 
 
 
 Copilot 
 Copilot 
 
 
 
 You 
 You 
 
 
 
 Gemini 
 Gemini 
 
 
 
 DeepSeek 
 DeepSeek 
 
 
 
 Meta AI 
 Meta AI 
 
 
 
 Grok 
 Grok 
 
 
 
 Qwen 
 Qwen Waze Waze Ngena ngemvume Ngena ngemvume Ukukhangisa Ukukhangisa ikhaya ikhaya Yini Yini Ikhaya Ikhaya Ngena ngemvume Ngena ngemvume Ukucaciswa Ukucaciswa Ukuhlobisa Ukuhlobisa Kwangathi Kwangathi Ukungena ngemvume Ufuna ukwakha i-API ye-MCP ne-AI namhlanje. I-API ye-versioning inikeza amakhasimende akho ukukhusela izinguquko, kodwa ukusetshenziswa okuphakeme inikeza izimpendulo zokusebenza kanye nokumangaliswa kwamakhasimende. I-Version ye-API yakho ngokucacileyo - kuphela uma ungenza izinguquko ezibangelwa ku-integrations eyenziwe. You need API versioning to keep your API reliable and backward-compatible when adding breaking changes. Ukusetshenziswa kwe-URL path ye-versions kuyinto elula futhi elula. I-HTTP header versioning ivimbela i-URL emangalisayo kodwa ivimbela ukucindezeleka, kanti i-query parameter versioning iyadingeka ngokuvamile. Qinisekisa isitifiketi version esifanele, test version ngokugcwele, futhi ukunciphisa ama-versions ezinhle ngokushesha. Lezi zokusebenza zihlanganisa abasebenzisi bakho we-API futhi ikhadi lakho lwezinhlelo zokusebenza. https://hackernoon.com/code-smell-303-how-to-prevent-breaking-existing-clients-when-you-make-changes https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xii https://hackernoon.com/code-smell-272-api-chain?embedable=true https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xxxviii I-Disclaimer I-Code Smells Is My . Umhlahlandlela Imininingwane isithombe Yini U-Marcus Urbenz Ngena ngemvume 
 
 Uma usofthiwe, uye umenzi we-API. Ikhodi elungileyo i-modular - wonke imoduli inesisindo se-API. Uma usofthiwe, uye umenzi we-API. Ikhodi elungileyo i-modular - wonke imoduli inesisindo se-API. U-Joshua Bloch https://hackernoon.com/400-thought-provoking-software-engineering-quotes?embedable=true Okuzenzakalelayo ingxenye yeCodeSmell Series. 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

Lo msindo ukhiqizwa ngolimi lokuqala lwendaba!

Kude kakhulu; Uzofunda

Make resilience your competitive advantage

I-Code Smell 309 - I-Query Parameter API ye-Versioning

I-Code Smell 309 - I-Query Parameter API ye-Versioning

About Author

IMIBONO

HANG TAGS

LESI SIHLOKO SETHULWE NGAPHAKATHI

Related Stories

Zulu Network: Moving The Bitcoin Economy Forward With a Two-Tiered Bitcoin Layer 2 Architecture

The Billionaires F*cked Up

Zulu Network: Moving The Bitcoin Economy Forward With a Two-Tiered Bitcoin Layer 2 Architecture

The Billionaires F*cked Up

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps