კითხვის პარამეტრების უარყოფითი გამოყენება API- ის შენარჩუნებას შეუზღუდავს 
 
 TL;DR: გამოიყენეთ URL გზა ან headers API versioning. TL;DR: გამოიყენეთ URL გზა ან headers API versioning. პრობლემები 
 
 
 
 
 
 
 
 
 
 
 
 კონფიგურაციის პარამეტრები მაღალი შენარჩუნება Incoherent ვერსია მომხმარებლის შეცდომები უარყოფითი კითხვები Backward კონფიგურაცია URL კლიენტები Hidden კომბინაცია არასწორი სინამიკა პარამეტრები Collisions Breaking ცვლილებები გადაწყვეტილებები 
 
 
 
 
 
 
 URL გზა შეამოწმეთ პარამეტრები უპირატესობა Headers ვერსია გადარჩენა შეცდომები შეინახეთ ძველი ვერსია ძველი ვერსია მძიმე კონტაქტი როდესაც თქვენ შეცვალოთ API-ს, რომელიც არსებობს კლიენტები, თქვენ შექმნათ პრობლემები. შეჩერება იმისათვის, რომ თავიდან ავიცილოთ ეს, თქვენ უნდა ვერსია თქვენი API. Versioning საშუალებას გაძლევთ დაამატოთ ახალი ფუნქციონები ან შეცვალოს ქცევა, გარეშე გაჩერების ძველი კლიენტები მუშაობა. ჩვეულებრივ, ვერსია ნომერი API URL path, HTTP headers, ან, ნაკლებად, კითხვის პარამეტრები. ყველა მეთოდი აქვს უპირატესობები და უპირატესობები. URL path versioning არის მარტივი და ჩანს. Header versioning შენარჩუნებს URLs სუფთა, მაგრამ დაამატა კომპლექსის. კითხვის პარამეტრები შეიძლება შეუზღუდავი URLs და შეიძლება იყოს შეუზღუდავი. გამოიყენეთ ვერსიარება მხოლოდ შეცვლა. მართვის მრავალჯერადი ვერსია გაზრდის შენარჩუნების მუშაობა, მაგრამ უზრუნველყოფს საიმედოობა და მომხმარებლის უსაფრთხოება. Sample კოდი არასწორი <?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] ავტომატური თქვენ შეგიძლიათ იპოვოთ ხმა, როდესაც თქვენი Endpoints მოიცავს . ვერსია = 1 Linters და API დიზაინი მიმოხილვა შეუძლია შეამოწმოს პარამეტრები, რომლებიც გამოიყენება ვერსიაფიკაციისთვის. თქვენ შეგიძლიათ იპოვოთ ეს ხმა, თუ ხედავთ კლიენტებს, რომლებიც API-ის ცვლილებების შემდეგ გაქირავებენ, ან თუ ვერსიაფიკაციის გაკეთება არ არის შეესაბამება. Search for use of query parameters to define versions or multiple undocumented methods. შეამოწმეთ, თუ ძველი ვერსია ჯერ კიდევ პასუხისმგებლობა, მაგრამ არ აღწერილი ან დოკუმენტული. ️ ️ 
 
 Apiა დონე 
 
 [x] მეშვეობით რატომ არის მნიშვნელოვანია ️ API ვერსია უნდა რუკა გაუმჯობესება თქვენი domain მოდელი. ერთი ერთი როდესაც თქვენ შექმნათ ვერსია non-breaking ცვლილებები, თქვენ გაქვთ ეს და შექმნათ შეუზღუდავი რამ, რაც შეიცავს მნიშვნელოვანი ცვლილება. რუკა ეს იწვევს ვერსია გაფართოება, სადაც კლიენტებს არ შეუძლიათ აირჩიოთ, რა ვერსია მათ ნამდვილად საჭიროა, რაც თქვენი API- ს უფრო რთულია. როდესაც API ვერსია ნათლად შეესაბამება მომხმარებლის კონტაქტები, კლიენტებს იცით, რა მონაცემები და ქცევა უნდა მოითხოვოს. ამ ერთ-ერთი mapping გაქირავების მიერ შეცვალოს API ქცევა ვერსიაფიკაციის გარეშე იწვევს კლიენტების შეუზღუდავი და runtime შეცდომები. Clear ვერსია შენარჩუნებს ეს intact და საიმედო. რუკა AI გენერატორები შეიძლება შექმნათ კოდი შეუზღუდავი ან არ არსებობს API ვერსია, განსაკუთრებით თუ მოითხოვს მარტივი მაგალითებს. AI გენერატორები ხშირად აწარმოებს სწრაფი და მშრალი Endpoints კითხვის პარამეტრები. ისინი ოპტიმიზირებენ სიჩქარით, არა სმანტიკაში. კონტაქტი AI ინსტრუმენტები შეუძლიათ იპოვოს ეს ხასიათი ანალიზი Endpoint მოდელები, შედარებით რეაგირების გრაფიკები სხვადასხვა ვერსია, და იპოვოს მინიმალური განსხვავებები API ვერსია. მათ შეუძლიათ გთავაზობთ შეუზღუდავი ცვლილებების შეუზღუდავი შეუზღუდავი ვერსია. ცდილობენ მათ! გაითვალისწინეთ: AI Assistants გააკეთა ბევრი შეცდომები 
 
 Suggested Prompt: გამოიყენეთ API ვერსია URL- ში Suggested Prompt: გამოიყენეთ API ვერსია 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 ჩატი ჩატი კოლადის კოლადის შეშფოთება შეშფოთება Copilot Copilot თქვენ თქვენ ორმაგი ორმაგი DeepSeek DeepSeek მიზნები მიზნები გროკები გროკები კუნძული კუნძული კონტაქტი თქვენ უნდა შექმნათ APIs MCPs და AIs დღეს. API ვერსიაფიკაციის დაცვა თქვენი კლიენტებს შეცდომები, მაგრამ ზედმეტი გამოყენება ხელს უწყობს შენარჩუნება და კლიენტების შეუზღუდავი. თქვენი API-ების ვერსია განიცდიან - მხოლოდ როდესაც თქვენ გააკეთებთ უარყოფითი ცვლილებები, რომლებიც იწვევს ხელმისაწვდომი ინტეგრიზებს. თქვენ უნდა API ვერსიაფიკაცია, რათა თქვენი API არის საიმედო და backward-compatible, როდესაც დაამატოთ breakthrough შეცდომები. გამოყენება URL path for ვერსია არის მარტივი და ნათელი. HTTP header ვერსიაფიკაცია შენარჩუნებს URL-ები სუფთა, მაგრამ დამატებს კომფორტებას, ხოლო კითხვის პარამეტრების ვერსიაფიკაცია ზოგადად უნდა თავიდან ავიცილოთ. შეინარჩუნეთ ნათელი ვერსია დოკუმენტაცია, ტესტირება ვერსია სრულყოფილი, და შეამციროს ძველი ვერსია постепенно. ეს პრაქტიკა უზრუნველყოფს თქვენი 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 Code Smells არის ჩემი . კომენტარები კრედიტი ფოტო ეს მარკუს Urbenz Unsplash საწყისი 
 
 თუ თქვენ პროგრამირება, თქვენ API დიზაინერი. კარგი კოდი არის მოდული — თითოეული მოდული აქვს API. თუ თქვენ პროგრამირება, თქვენ API დიზაინერი. კარგი კოდი არის მოდული — თითოეული მოდული აქვს API. JOSHUA BLOCK 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 Parameter API ვერსია

Code Smell 309 - Query Parameter API ვერსია

About Author

კომენტარები

დაკიდეთ ტეგები

ეს სტატია იყო წარმოდგენილი

Related Stories

Karl Ludwig Sand: Murder in the 1800s by Alexandre Dumas - Table of Links

Karak and Space and Time Join Forces to Revolutionize Blockchain Security

DAO-Funded Hardware Wallet Kampela Secures Polkadot Network Investment

Karma: Love on the Blockchain and the Gamification of Helping Others

Karl Ludwig Sand: Murder in the 1800s by Alexandre Dumas - Table of Links

Karak and Space and Time Join Forces to Revolutionize Blockchain Security

DAO-Funded Hardware Wallet Kampela Secures Polkadot Network Investment

Karma: Love on the Blockchain and the Gamification of Helping Others

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps