Ny fampiasana tsy ara-drariny amin'ny fanontaniana dia mampidi-doza amin'ny fikarakarana API 
 
 TL;DR: Mampiasa ny lalana URL na ny loharano ho an'ny API versioning. TL;DR: Mampiasa ny lalana URL na ny loharano ho an'ny API versioning. Ny olana 
 
 
 
 
 
 
 
 
 
 
 
 Mifandray amin'ny parameters Ny fitazonana avo lenta Ny dikan-teny tsy mifanaraka Ny fahadisoan'ny mpanjifa Ny fangatahana dia Tsy mifanaraka amin'ny Ny tranonkala Clutter Tsindrio ny fahasamihafana Ny fahadisoan'ny semantika Ny fametrahana ny parameters Ny fiovan'ny Ny vahaolana 
 
 
 
 
 
 
 Ampiasao ny lalana URL Miala tsiny amin'ny parameters Tia ny lohan'ny Ny dikan-teny amin'ny famerenana ny fiovana Mitohy ny dikan-teny taloha Ataovy azo antoka ny famoahana ny dikan-teny taloha Ny fifanarahana Rehefa manova ny API amin'ny fomba izay Ny mpanjifa amin'izao fotoana izao dia miteraka olana. Tapaka ny Mba hisorohana izany dia tsy maintsy mampiasa ny API ianao. Ny versioning dia ahafahanao manampy endri-javatra vaovao na manova fitondran-tena raha tsy manakana ny mpanjifa taloha tsy miasa. Matetika ianao dia mametraka ny laharan-tsary ao amin'ny API URL lalana, HTTP lohateny, na, tsy mahazatra, ao amin'ny fanontaniana parameters. Ny fomba tsirairay dia manana ny tombony sy ny tsy fahampian'ny. ny famoahana ny lalana URL dia tsotra sy azo jerena. Ny famoahana ny lohateny dia mitazona ny URL maivana fa manampy amin'ny fahasamihafana. Ny parametra fanontaniana dia afaka mampihomehy ny URLs ary mety ho mampihomehy. Ny fampiasana versioning ihany no ahafahana manova ny fanovana. Ny fitantanana dikan-teny maromaro dia mampitombo ny asa fanaraha-maso, fa manome antoka ny azo itokisana sy ny fahatokisan'ny mpampiasa. Tsindrio ny code. Ny fahadisoana <?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
 Ny marina <?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']);
}
 Ny famantarana 
 
 [x] Ny fametrahana Azonao atao ny mahita ny fahatsapana rehefa ahitana ny . Ny dikan-teny = 1 Ny Linters sy ny API design reviews dia afaka manamarika ny fanontaniana izay ampiasaina amin'ny versioning. Azonao atao ny mahita io fahatsapana io raha mahita ny mpanjifa manimba aorian'ny fiovana amin'ny API, na raha tsy mitovy amin'ny versioning. Jereo ny fampiasana parameter fanontaniana mba hahafantarana dikan-teny na fomba maro tsy voaporofo. Jereo raha mbola mifanaraka ny dikan-teny taloha, saingy tsy voatahiry na voaporofo mazava. Ny taona ️ 
 
 Ny APIs Ny ambaratonga 
 
 [X] Ny fifanarahana Nahoana no tena zava-dehibe ny fihaonambe ️ Ny endrika API dia tokony Amin'ny alalan'ny fanitsiana fiovana ao amin'ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny sehatry ny fitantanana. Ny iray amin'ireo Rehefa mamorona dikan-teny ho an'ny fanovana tsy mitsahatra ianao, dia mitsahatra izany ary mamorona fahasamihafana momba ny zavatra midika fiovana lehibe. Ny taratasy Izany dia mitarika amin'ny version spread, izay tsy afaka mamaritra izay dikan'izy ireo tena ilaina, izay mahatonga ny API sarotra kokoa amin'ny fampiasana sy ny fitazonana. Rehefa mifanaraka mazava tsara amin'ny fifanarahana fampiasana ny dikan'ny API, ny mpanjifa dia mahafantatra izay angon-drakitra sy ny fitondran-tena tokony hiandry. Ny fametrahana ity mapping iray amin'ny iray amin'ny iray amin'ny fanovana ny fitondran-tenan'ny API tsy misy versioning dia miteraka fahadisoana amin'ny mpanjifa sy ny fahadisoana amin'ny fotoana. Ny dikan-teny dia mitazona izany Mazava sy azo antoka. Ny mapping Ny taranaka Ny solosaina AI dia afaka mamorona code amin'ny API tsy mifanaraka na tsy misy versioning, indrindra raha nangataka ohatra tsotra. Ny famokarana AI matetika dia mamokatra endpoints haingana sy ratsy miaraka amin'ny parameters fanontaniana. Izy ireo dia manatsara ny haingana, fa tsy ny semantics. Ny famantarana Ny fitaovana AI dia afaka mahita ity fahatsapana ity amin'ny alalan'ny fanadihadiana ny endrika endpoint, mampitaha ny valin'ny valiny amin'ny dikan-teny, ary mahita fahasamihafana kely eo amin'ny dikan-teny API. Azonao atao ny manolotra fanitsiana tsy misy fiovana amin'ny dikan-teny misy anao. Manao izany ianao! Tsarovy: Manao fahadisoana maro ny mpanampy AI 
 
 Suggested Prompt: mampiasa ny API versions ao amin'ny URL Suggested Prompt: mampiasa ny API versions ao amin'ny 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 Ny chat Ny chat Ny renivohiny Ny renivohiny Ny fahadisoana Ny fahadisoana Ny mpamily Ny mpamily Ianao Ianao Ny Gemini Ny Gemini Ny fitadiavana Ny fitadiavana Ny tanjona Ny tanjona Ary ny Ary ny Ny Ny Ny fanapahan-kevitra Mila mamorona API ho an'ny MCPs sy AIs ianao amin'izao fotoana izao. Ny versioning API dia miaro ny mpanjifa amin'ny fanitsiana ny fanovana, fa ny fampiasana be dia be dia be dia be dia be dia be no miteraka nofy fikojakojana sy ny fahadisoan'ny mpanjifa. Version ny API tsara - raha toa ka manao fanovana mahery vaika izay mety hiteraka tsy fahombiazan'ny integrations misy. Mila fandaharana API ianao mba hitazonana ny API azo antoka sy mifanaraka amin'ny farany amin'ny fametrahana fanitsiana fanovana. Ny fampiasana ny lalana URL ho an'ny dikan-teny dia tsotra sy mazava. Ny versioning ny lohateny HTTP dia mitazona ny URL maivana, fa manampy amin'ny fahasamihafana, raha tsy tokony hisorohana ny versioning parameter ny fanontaniana. Ataovy mazava ny antontan-taratasy momba ny dikan-teny, manandrana ny dikan-teny tanteraka, ary mandroso ny dikan-teny taloha. Ity fampiharana ity dia mitazona ny mpampiasa API mahafinaritra ary ny codebase azo ampiasaina. Mifandraisa amin'izy ireo 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 Ny tsy fisian'ny Ny voankazo dia ny tenako . Ny hevitra Ny trosa Sary avy Ny Nandray anjara tamin'ny Tsy misy 
 
 Raha mampiasa programa ianao dia mpamorona API ianao. Ny code tsara dia modular - ny module tsirairay dia manana API. Raha mampiasa programa ianao dia mpamorona API ianao. Ny code tsara dia modular - ny module tsirairay dia manana API. Ny anaran'i Joshua Bloch https://hackernoon.com/400-thought-provoking-software-engineering-quotes?embedable=true Ity lahatsoratra ity dia ampahany amin'ny Series CodeSmell. 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

Ity horonam-peo ity dia novokarina tamin'ny fiteny niandohan'ny tantara!

Lava loatra; Mamaky

Make resilience your competitive advantage

Code Smell 309 - Query Parameter API Versioning amin'ny alàlan'ny fanadihadiana

Code Smell 309 - Query Parameter API Versioning amin'ny alàlan'ny fanadihadiana

About Author

COMMENTS

HANG TAGS

ITY ARTICLE ITY NO NARESAKA TAMIN'NY

Related Stories

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps