Πελάτης / δοκιμαστής REST API

Σύνθεση και αποστολή αιτήσεων HTTP με παραμέτρους ερωτήματος, κεφαλίδες, σώματα JSON / φόρμας και έλεγχο ταυτότητας Basic ή Bearer, και επιθεώρηση κατάστασης, χρόνου και απόκρισης JSON με διαμόρφωση. Εισαγωγή υπάρχουσας εντολής cURL ή αντιγραφή της τρέχουσας αίτησης πίσω ως cURL. Για αιτήσεις που χτίζονται βήμα προς βήμα και επαναχρησιμοποιούνται, χρήση του Κατασκευαστή αιτήσεων HTTP. Βλ. επίσης την οικογένεια εργαλείων API.
Όλα εκτελούνται τοπικά στο πρόγραμμα περιήγησης. Τα αιτήματα cross-origin υπόκεινται στην πολιτική CORS του διακομιστή-στόχου — βλ. τη σημείωση παρακάτω αν ένα αίτημα αποτύχει.
Παράμετροι ερωτήματος
Κεφαλίδες
Σώμα
Authorization
Επιλογές
Όταν συμπληρωθεί, η διεύθυνση του αιτήματος προστίθεται σε αυτό το πρόθεμα. Χρήσιμο για διακομιστές που μπλοκάρονται από CORS.
200
Σώμα Κεφαλίδες

                                                                
Γιατί μπορεί να αποτύχει ένα αίτημα: οι περιηγητές μπλοκάρουν τις αναγνώσεις cross-origin, εκτός αν το API επιστρέφει Access-Control-Allow-Origin. Αν ο στόχος δεν επιτρέπει CORS, μπορεί να χρησιμοποιηθεί ένας διακομιστής μεσολάβησης CORS με δική του διεύθυνση, η οποία τοποθετείται στο πεδίο προθέματος παραπάνω, ή ο Μετατροπέας cURL για εκτέλεση του αιτήματος από τερματικό. Τα σώματα αιτημάτων για GET/HEAD αγνοούνται, και ο δοκιμαστής WebSocket βρίσκεται χωριστά στο Δοκιμαστή WebSocket.
Μέθοδοι HTTP εξηγημένες
Η μέθοδος που επιλέγεται δηλώνει στον διακομιστή τι πρέπει να γίνει με τη διεύθυνση URL. Εδώ είναι τι σημαίνει καθένα από τα επτά ρήματα που μπορεί να στείλει αυτό το εργαλείο:
GET — Ανάκτηση ενός πόρου: μιας ιστοσελίδας, μιας εικόνας, μιας λίστας εγγραφών. «Επιστροφή του περιεχομένου αυτής της διεύθυνσης.» Μόνο ανάγνωση και ασφαλές για επανάληψη, και συνήθως δεν φέρει σώμα αιτήματος (σώμα σε αίτημα GET, αν υπάρχει, αγνοείται).
POST — Αποστολή νέων δεδομένων στον διακομιστή, συνήθως για δημιουργία πόρου ή εκκίνηση ενέργειας — υποβολή φόρμας, μεταφόρτωση αρχείου, εκκίνηση εργασίας. Το φορτίο μεταφέρεται στο σώμα του αιτήματος. Το POST δεν είναι ιδεμποτέντ: η αποστολή του ίδιου POST δύο φορές μπορεί να δημιουργήσει δύο εγγραφές.
PUT — Αντικατάσταση ολόκληρου του πόρου στη διεύθυνση URL με ό,τι αποστέλλεται. Το σώμα πρέπει να περιέχει την πλήρη νέα έκδοση του πόρου. Το PUT είναι ιδεμποτέντ: η επανάληψη του ίδιου αιτήματος έχει το ίδιο αποτέλεσμα με μία αποστολή.
PATCH — Αλλαγή μόνο μέρους ενός πόρου. Αποστέλλονται μόνο τα πεδία που πρόκειται να ενημερωθούν, π.χ. {"email": "new@example.com"}, αντί ολόκληρης της εγγραφής. Η επιλογή του PATCH είναι κατάλληλη όταν ένα πλήρες PUT θα υποχρέωνε να αποσταλούν πεδία που δεν αλλάζουν.
DELETE — Κατάργηση του πόρου στη διεύθυνση URL. Το DELETE είναι ιδεμποτέντ: η διαγραφή ενός στοιχείου που έχει ήδη εξαφανιστεί δίνει το ίδιο αποτέλεσμα (συνήθως 404) και δεν κάνει τίποτα δεύτερη φορά.
HEAD — Όπως το GET, αλλά η απόκριση περιέχει μόνο κεφαλίδες — δεν αποστέλλεται καθόλου σώμα. Χρήση του HEAD για έλεγχο ύπαρξης μιας διεύθυνσης, μεγέθους αρχείου (Content-Length), τελευταίας τροποποίησης (Last-Modified) ή τύπου (Content-Type), χωρίς λήψη ολόκληρου του φορτίου.
OPTIONS — Ερώτηση στον διακομιστή ποιες μέθοδοι και επιλογές επιτρέπονται για μια διεύθυνση, ή εκκίνηση ελέγχου προ-πτήσης CORS. Οι κεφαλίδες απόκρισης, όπως η Access-Control-Allow-Methods, δείχνουν τι επιτρέπεται. Το OPTIONS συνήθως δεν φέρει σώμα· οι περιηγητές το στέλνουν συχνά αυτόματα πριν από cross-origin POST/PUT/PATCH/DELETE.
Εύκολο να μπερδευτεί: HEAD vs GET — το αίτημα είναι ίδιο, αλλά το HEAD δεν επιστρέφει σώμα. PUT vs PATCH — το PUT αντικαθιστά ολόκληρο τον πόρο· το PATCH εφαρμόζει μερική ενημέρωση μόνο των πεδίων που αποστέλλονται.