Η κατάχρηση παραμέτρων ερωτήματος περιπλέκει τη συντήρηση του API 
 
 TL;DR: Χρησιμοποιήστε διαδρομές URL ή επικεφαλίδες για την έκδοση του API. TL;DR: Χρησιμοποιήστε διαδρομές URL ή επικεφαλίδες για την έκδοση του API. Προβλήματα 
 
 
 
 
 
 
 
 
 
 
 
 Συγκλονιστικές παραμέτρους Υψηλή συντήρηση Ανομοιόμορφη εκδοχή Λάθη πελατών Απαράδεκτα αιτήματα Αναδρομική ασυμβατότητα Ομάδα Clutter Η κρυφή πολυπλοκότητα Λάθος σημασιολογία Παράμετροι σύγκρουσης Σπάζοντας τις αλλαγές Λύσεις 
 
 
 
 
 
 
 Οδηγίες URL Αποφυγή παραμέτρων αναζήτησης Προτιμούν τα κεφάλια Η έκδοση για την κατάρρευση των αλλαγών Κρατήστε τις παλιές εκδόσεις σε λειτουργία Προσέξτε προσεκτικά τις παλιές εκδόσεις ΠΕΡΙΓΡΑΦΟ Όταν αλλάζετε ένα API με τρόπο που Οι υπάρχοντες πελάτες δημιουργούν προβλήματα. Σπάει Για να αποφύγετε αυτό, πρέπει να εκδώσετε το API σας. Η έκδοση σας επιτρέπει να προσθέσετε νέες λειτουργίες ή να αλλάξετε τη συμπεριφορά χωρίς να σταματήσετε τους παλιούς πελάτες να λειτουργούν. Συνήθως τοποθετείτε τον αριθμό έκδοσης στη διαδρομή URL του API, στις επικεφαλίδες HTTP ή, λιγότερο συχνά, στις παραμέτρους ερωτήματος. Κάθε μέθοδος έχει πλεονεκτήματα και μειονεκτήματα. η έκδοση της διαδρομής URL είναι απλή και ορατή. η έκδοση κεφαλίδας διατηρεί τις διευθύνσεις URL καθαρές αλλά προσθέτει πολυπλοκότητα. Οι παράμετροι ερωτήματος μπορούν να προκαλέσουν σύγχυση στις διευθύνσεις URL και να προκαλέσουν σύγχυση. Χρησιμοποιήστε την έκδοση μόνο για να σπάσετε τις αλλαγές. Η διαχείριση πολλαπλών εκδόσεων αυξάνει το έργο συντήρησης, αλλά εξασφαλίζει την αξιοπιστία και την εμπιστοσύνη των χρηστών. Ετικέτες ΚΩΔΙΚΑ Λάθος 🙂 <?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 ή εάν η έκδοση γίνεται ασυνεπώς. Αναζητήστε τη χρήση παραμέτρων ερωτήματος για τον καθορισμό εκδόσεων ή πολλαπλών μη τεκμηριωμένων μεθόδων. Ελέγξτε αν οι παλιές εκδόσεις εξακολουθούν να ανταποκρίνονται, αλλά δεν διατηρούνται ρητά ή δεν τεκμηριώνονται. ️️ 
 
 ΑΠΙ Επίπεδα 
 
 [x] Μέσος όρος Γιατί είναι σημαντική η προετοιμασία ️ Οι εκδόσεις API θα πρέπει να χαρτογραφούν Αλλαγές στο μοντέλο domain σας. ΕΝΑ ΜΕ ΕΝΑ Όταν δημιουργείτε εκδόσεις για μη σπάζουσες αλλαγές, σπάτε αυτό το και δημιουργούν σύγχυση για το τι συνιστά σημαντική αλλαγή. Χάρτης Αυτό οδηγεί σε διασπορά έκδοσης, όπου οι πελάτες δεν μπορούν να καθορίσουν ποια έκδοση χρειάζονται πραγματικά, καθιστώντας το API σας πιο δύσκολο να καταναλωθεί και να συντηρηθεί. Όταν οι εκδόσεις API αντιστοιχούν σαφώς σε συμβάσεις χρήσης, οι πελάτες γνωρίζουν ποια δεδομένα και συμπεριφορά να περιμένουν. Η διακοπή αυτής της αντιστοίχισης ενός προς ενός με την αλλαγή της συμπεριφοράς του API χωρίς εκδόσεις προκαλεί σύγχυση του πελάτη και σφάλματα χρόνου εκτέλεσης. Η καθαρή εκδοχή διατηρεί αυτό άθικτο και αξιόπιστο. Χάρτης Η γενιά μας Οι γεννήτριες AI μπορούν να δημιουργήσουν κώδικα με ασυνέπεια ή χωρίς έκδοση API, ειδικά αν ζητηθούν απλά παραδείγματα. Οι γεννήτριες AI συχνά παράγουν γρήγορα και βρώμικα τερματικά σημεία με παραμέτρους ερωτήματος. Η ανίχνευση Τα εργαλεία τεχνητής νοημοσύνης μπορούν να ανιχνεύσουν αυτή τη μυρωδιά αναλύοντας τα πρότυπα των τερματικών σημείων, συγκρίνοντας τα σχήματα απόκρισης μεταξύ των εκδόσεων και εντοπίζοντας ελάχιστες διαφορές μεταξύ των εκδόσεων του API. Μπορούν να προτείνουν την ενοποίηση μη ρήξεων αλλαγών σε υπάρχουσες εκδόσεις. Δοκιμάστε το! Θυμηθείτε: Οι βοηθοί AI κάνουν πολλά λάθη 
 
 Προτεινόμενη γραμμή: χρησιμοποιήστε εκδόσεις API στην διεύθυνση URL Προτεινόμενη γραμμή: χρησιμοποιήστε εκδόσεις 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 Τσακαλώτος Τσακαλώτος Κλοντ Κλοντ ΔΥΣΚΟΛΙΑ ΔΥΣΚΟΛΙΑ Πιλότος Πιλότος Εσύ Εσύ Δίδυμοι Δίδυμοι Βαθιά Βαθιά Στόχος η Στόχος η Γκρόκο Γκρόκο ΚΟΥΕΝ ΚΟΥΕΝ Συμπέρασμα Πρέπει να δημιουργήσετε API για MCPs και AIs σήμερα. Η έκδοση του API προστατεύει τους πελάτες σας από την παραβίαση αλλαγών, αλλά η υπερβολική χρήση δημιουργεί εφιάλτες συντήρησης και σύγχυση πελατών. Εκδόσεις των API σας με σύνεση - μόνο όταν κάνετε σημαντικές αλλαγές που θα προκαλούσαν την αποτυχία των υφιστάμενων ενσωματώσεων. Χρειάζεστε εκδόσεις API για να διατηρήσετε το API σας αξιόπιστο και συμβατό προς τα πίσω όταν προσθέτετε αλλαγές ρήξης. Η χρήση της διαδρομής URL για τις εκδόσεις είναι απλή και σαφής. Η έκδοση κεφαλίδας HTTP διατηρεί τις διευθύνσεις 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 Αποκάλυψη Η μυρωδιά είναι δική μου . Γνώμη Πιστωτικές Φωτογραφία από είναι ΜΑΡΚΟΥΣ ΟΡΒΕΝΖ Μυστηριώδης 
 
 Εάν προγραμματίζετε, είστε σχεδιαστής 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 - Αναζήτηση παραμέτρων API Versioning

Code Smell 309 - Αναζήτηση παραμέτρων API Versioning

About Author

ΣΧΟΛΙΑ

ΚΡΕΜΑΣΤΕ ΕΤΙΚΕΤΕΣ

ΑΥΤΟ ΤΟ ΑΡΘΡΟ ΠΑΡΟΥΣΙΑΣΤΗΚΕ ΣΤΟ

Related Stories

The Pros and Cons of Electric Cars

The 2.0 Conferences Spark Global Conversations With HackerNoon As Esteemed Media Partner

The DevOps Writing Contest by Aptible: Round 4 Winners Announced!

OpenAI Trustees Accused of Misusing Donor Funds

The Pros and Cons of Electric Cars

The 2.0 Conferences Spark Global Conversations With HackerNoon As Esteemed Media Partner

The DevOps Writing Contest by Aptible: Round 4 Winners Announced!

OpenAI Trustees Accused of Misusing Donor Funds

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps