REST - Comment allusion clients sur la façon de représenter les données tout en maintenant le découplage

Question

Par souci de simplicité, disons que nous stockons des informations personnelles comme tant d'utilisateurs (JSON, mais ce n'est pas le point):

{ 
    "name": "John" 
    "age": 35 
    "sex": "M" 
} 

Nous voulons que le client de l'interface utilisateur crée un formulaire pour afficher ces informations et également pour créer de nouveaux utilisateurs ou mettre à jour des utilisateurs existants.

Alors, ma question est:

Comment cela peut-il être atteint d'une manière RESTful? Est-ce que REST prévoit même ce genre d'interactions, c'est-à-dire, suggérer aux clients comment afficher les ressources fournies?

Nous souhaitons donner aux clients un maximum de liberté sur la façon de représenter les ressources, mais aussi de les aider à nous renvoyer les données correctes sans trop de couplage entre backend et frontend.

Par exemple, nous pourrions avoir un modèle pour user comme ceci:

{ 
    "self": "/template/user" 
    "method": "GET" 
    "data": { 
     "fields": [ 
       { 
        "name": "name" 
        "value": { 
         "data_type": "string"      
        } 
       }, 
       { 
        "name": "age" 
        "value": { 
         "data_type": "number"      
        } 
       }, 
       { 
        "name": "sex" 
        "value": { 
         "data_type": "string" 
         "options": [ 
          "M", 
          "F" 
         ] 

        } 
       } 
     ] 
    } 
} 

Merci pour toute entrée que vous pourriez être en mesure de fournir.

Answer 1

Comment cela peut-il être réalisé de manière RESTful? Est-ce que REST prévoit même ce genre d'interactions, c'est-à-dire, suggérer aux clients comment afficher les ressources fournies?

L'application de référence pour REST est le World Wide Web; comment l'avons-nous fait là?

1) nous avons utilisé un type de média (HTML) qui a soutenu dans les instructions de présentation de la bande qui pourrait, à la discrétion du client, être interprétées par le choix du client de moteur de rendu

2) nous avons fourni des liens vers des ressources auxiliaires (CSS) qui pourrait éventuellement être récupérée pour fournir des indications de présentation supplémentaires au moteur de rendu. Notez que cela dépendait du fait que text/html et text/css étaient bien définis (standardisés) afin que les moteurs de rendu (navigateurs) puissent être développés indépendamment des serveurs.

Je n'ai vu aucune alternative au HTML comme standard pour le partage des instructions de rendu avec le client. Ma suggestion en tant que première approche serait de lier votre représentation de données à une représentation html, qui peut être utilisée par les clients qui comprennent le rendu.