Με ποιο πρότυπο περιγράψατε το REST API; Πώς κάνετε ένα POST ιδιομεταβλητό;

Συχνά, για την περιγραφή του REST API, χρησιμοποιείται το πρότυπο OpenAPI (προηγουμένως γνωστό ως Swagger). Επιτρέπει τον τυποποιημένο ορισμό της περιγραφής API σε μορφή YAML ή JSON, διευκολύνοντας τη δημιουργία τεκμηρίωσης, SDK πελάτη και δοκιμών.

Για να κάνετε ένα POST idempotent, μπορείτε να χρησιμοποιήσετε διάφορες προσεγγίσεις:

• Ενσωματώστε έναν μοναδικό αναγνωριστικό (π.χ., Idempotency-Key) στους επικεφαλίδες. Ο διακομιστής, λαμβάνοντας ένα επαναλαμβανόμενο αίτημα με το ίδιο κλειδί, δεν θα δημιουργήσει διπλότυπο, αλλά θα επιστρέψει το αποτέλεσμα του πρώτου αιτήματος.
• Χρησιμοποιήστε PUT αντί για POST, καθώς το PUT είναι idempotent από προεπιλογή (ενημερώνει έναν πόρο σε ένα γνωστό URI).

Παράδειγμα με Idempotency-Key:

POST /orders HTTP/1.1
Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json

{ "product_id": 42, "quantity": 1 }

Εάν ο διακομιστής έχει λάβει προηγουμένως αυτό το αίτημα με αυτό το κλειδί, θα επιστρέψει την ίδια απάντηση χωρίς να δημιουργήσει νέα παραγγελία.