د پوښتنې پارامترونو غلط استعمال د API ساتنې سختوي 
 
 TL;DR: د API نسخه کولو لپاره د URL پټونو یا headers کارول. TL;DR: د API نسخه کولو لپاره د URL پټونو یا headers کارول. د ستونزو 
 
 
 
 
 
 
 
 
 
 
 
 د مختلفو پارامترونو د لوړ ساتنې غیرقانوني نسخه د مشتریانو غلطۍ اړتیاوې نږدې غیرقانوني د URL Clutter مخکښ پیچیدو د غلط Semantics پارامترونه بدلونونه د حل 
 
 
 
 
 
 
 د URL لارښوونې د پوښتنو پارامترونو د مخنیوی ترټولو headers د بدلون په اړه نسخه د قديم ورژنونه چلند وکړي د قدیم نسخهونو په احتیاط سره د کنټرول کله چې تاسو د API په داسې توګه بدل کړئ چې د موجودي مشتریانو، تاسو ستونزو جوړ کړئ. د حلقوي د دې مخنیوی لپاره، تاسو باید خپل API نسخه کړئ. Versioning تاسو ته اجازه ورکوي چې تاسو د نوي ځانګړتیاوې اضافه یا د عمل بدلون پرته پرته د پیرودونکو کار وکړي. تاسو معمولا د ورژن شمیره په API URL پټ، HTTP مخونه، او يا، په کم عمده توګه، په پوښتنې پارامترونو کې. هر روش د منفي او منفي لري. د URL پړاو نسخه کولو ساده او ښيي. د headers نسخه کولو د URLs پاک کوي مګر د پیچیدو اضافه کوي. د پوښتنو پارامترونو کولی شي د URLs مخنیوی شي او کولی شي مخنیوی وي. د نسخه کولو لپاره یوازې د بدلونونو د مخنیوی لپاره کارول کیږي. د ډیرو نسخهونو مدیریت د ساتنې کار زیاتوي، مګر د اعتماد او کاروونکي اعتماد تضمین کوي. د نمونوي کوډ په غلطۍ کې <?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
 حق <?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']);
}
 د څارنې 
 
 [x] د اتومات تاسو کولی شئ کله چې ستاسو د پایپ ټکي شامل دي، د بوی تشخیص کړئ . د نسخه = 1 Linters او API ډیزاین نظرونه کولی شي د نسخه کولو لپاره کارول شوي پارامترونو ته نښه کړي. تاسو کولی شئ د دې عطر کشف کړئ که تاسو د API بدلونونو وروسته کلینټونه روښانه ونیسئ یا که نسخه کولو غیرقانوني ترسره کیږي. د پوښتنې پارامترونو کارولو لپاره د ورژنونو یا د ډیری غیر دستاوي طریقې د تعریف لپاره وګورئ. چمتو کړئ که څه هم د قديم ورژنونو ځواب لري، مګر په ځانګړې توګه د ساتنې یا سند نه لري. د روزنې ️ 
 
 د APIs د سطحې 
 
 [x] د منځني چرا د بیجیکشن مهم دی ️ API نسخه باید نقشه په خپل ډومین ماډل کې د بدلونونو سره. د یو کله چې تاسو د بدلونونو لپاره نسخه جوړ کړئ، تاسو دا راټول کړئ او د هغه څه په اړه چې یو مهم بدلون جوړ کوي، د مخنیوي جوړولو. د نقشه دا د نسخه پراختیا ته وده ورکوي، کوم چې مشتریانو کولی شي د هغه نسخه چې دوی په حقیقت کې اړتيا لري، ستاسو د API د مصرف او ساتنې سخت کړي. کله چې د API نسخه په واضح ډول د کاروونکو قراردادونو سره مطابقت کوي، مشتریانو پوه شي چې هغه معلوماتو او عملونه چې باید انتظار وکړي. د انټرنټ کولو پرته د انټرنټ کولو پرته د انټرنټ کولو پرته د انټرنټ کولو په کارولو سره د انټرنټ کولو په کارولو سره د انټرنټ کولو په کارولو سره د انټرنټ کولو په کارولو سره د انټرنټ کولو په کارولو سره د انټرنټ کولو په کارولو سره د انټرنټ کولو په کارولو سره کارول کیږي. Breaking this one-to-one mapping by changing API behavior without versioning causes client confusion and runtime errors. د واضح ورژن د دې ساتنه کوي ناڅاپي او قابل اعتماد. د نقشه د نسل AI جنراتورونه کولی شي کوډ سره غیر متوازن یا د API نسخه نه جوړ کړي، په ځانګړي ډول که د ساده مثالونو لپاره اړتیا لري. AI جنراتورونه معمولا د پوښتنې پارامترونو سره چټک او بریښنا پایپ تولید کوي. دوی د سرعت لپاره، نه سمینټیک لپاره غوره کوي. د څارنې د AI وسایلو کولی شي د انډیپیکټ نمونې تحلیل کولو، د نسخهونو په پرتله د ځواب سیسټمونو په پرتله، او د API نسخهونو ترمنځ لږ تر لږه فرقونه کشف کړي. دوی کولی شي د موجودو نسخهونو کې د غیر متوازن بدلونونو رامینځته کړي. هڅه وکړئ! په یاد ولرئ: د AI مسلکي ډیری غلطونه کوي 
 
 Suggested Prompt: په url کې د API نسخه کارول Suggested Prompt: په url کې د API نسخه کارول 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 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 چټک چټک د کلورډ د کلورډ مخکښ مخکښ د پالیسۍ د پالیسۍ تاسو تاسو جینی جینی DeepSeek کې DeepSeek کې هدف AI هدف AI ګرځنده ګرځنده د چين د چين د پایلو تاسو باید د MCPs او AIs لپاره APIs جوړ کړئ. د API نسخه کول ستاسو مشتریانو ته د بدلونونو له امله ساتنه کوي، مګر د کارولو په پرتله د ساتنې نارینه او د مشتریانو د مخنیوی جوړوي. ستاسو د APIs په عادي ډول ورژن کړئ - یوازې کله چې تاسو بدلونونه ترسره کړئ چې د موجودې انټرنېټونو ناکام شي. تاسو د API نسخه کولو ته اړتیا لرئ ترڅو ستاسو د API د اعتبار وړ او پیژندنې سره مطابقت ولري کله چې د بدلونونو اضافه کړئ. د نسخه لپاره د URL پټ کارولو ساده او واضح دی. HTTP headers versioning URLs پاک کوي مګر د پیچیدو اضافه کوي، په داسې حال کې چې د پوښتنې پارامترونه versioning په عمومي توګه باید مخنیوی شي. د نسخې د دستاویزاتو په صاف ډول، د نسخې په بشپړه توګه ازموينه، او د قديم نسخهونو په دوامداره توګه له لاسه ورکړي. دا عملی ستاسو د API کاروونکو خوشحاله کوي او ستاسو د کوډ بیس ساتل کیږي. 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 Disclaimer د کوډ عطرونه زما دي . د نظر د کریډیټ انځورونه د مارکوس Urbenz د نندارتون 
 
 که تاسو پروګرام کړئ، تاسو د API ډیزاینر یاست. ښه کوډ ماډولر دی - هر ماډول د API لري. که تاسو پروګرام کړئ، تاسو د API ډیزاینر یاست. ښه کوډ ماډولر دی - هر ماډول د API لري. د جوزف بلاچ https://hackernoon.com/400-thought-provoking-software-engineering-quotes?embedable=true دا مقاله د 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

دا غږ د کیسې په اصلي ژبه تولید شوی!

ډېر اوږد؛ لوستل

Make resilience your competitive advantage

Code Smell 309 - Query پارامتر API Versioning

Code Smell 309 - Query پارامتر API Versioning

About Author

تبصرې

hang tags

دا مقاله په کې وړاندې شوې وه

Related Stories

Psychology of the Unconscious by C. G. Jung - Table of Links

Tran Hung is HackerNoon's Altcoin Champion of 2021

Building Inclusive Tech: Interview with HackerNoon Contributor of the Year IOT 2021

[Writing Prompt] Thrilled to be Recognized as [Insert Award Title Name]

Psychology of the Unconscious by C. G. Jung - Table of Links

Tran Hung is HackerNoon's Altcoin Champion of 2021

Building Inclusive Tech: Interview with HackerNoon Contributor of the Year IOT 2021

[Writing Prompt] Thrilled to be Recognized as [Insert Award Title Name]

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps