Τι τύποι συμβάσεων εφαρμόζονται κατά τη δημιουργία ενός REST API;

Κατά τη δημιουργία REST API εφαρμόζονται οι ακόλουθοι τύποι συμβολαίων:

• OpenAPI (Swagger) — πρότυπο για την περιγραφή REST API, που επιτρέπει την τεκμηρίωση και τη δημιουργία πελάτη κώδικα.
• JSON Schema — ορίζει τη δομή των αντικειμένων JSON που χρησιμοποιούνται σε αιτήματα και απαντήσεις.
• gRPC (αν και δεν είναι REST, χρησιμοποιείται μερικές φορές ως συμβόλαιο για API) — πρωτόκολλο με συμβόλαιο βασισμένο σε protobuf.

Στο πλαίσιο των REST API, χρησιμοποιείται κυρίως το OpenAPI, το οποίο περιγράφει:

• Τελικά σημεία (μονοπάτια και μέθοδοι HTTP)
• Μορφές αιτημάτων και απαντήσεων
• Παραμέτρους και επικεφαλίδες
• Κωδικούς απάντησης

Παράδειγμα απλού τμήματος OpenAPI:

paths:
  /users:
    get:
      summary: Λήψη λίστας χρηστών
      responses:
        '200':
          description: Επιτυχής απάντηση
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'