Récemment, notre société a développé un projet côté PC, côté application mobile et côté Web mobile. Existe-t-il des bonnes pratiques populaires pour la conception du format de données JSON renvoyé par l'interface API ?
Actuellement, j'ai trouvé les versions suivantes
Version 1 : Exécutée avec succès : code d'état principal :2XX
json {"id":51,"age":58,"name":"lifei"}
Échec de l'exécution de la tête Code d'état : 4XX-5XX {"message": "erreur xxxxxx", "erreurs : {}}
Version 2 : Code d'état de la tête d'exécution réussie et échouée : 2xx
json {"code":"0","message:"information","data":{}}
Version 3 : Exécutée avec succès : code d'état principal :2XX
json {"id":51,"age":58,"name":"lifei"}
Échec de l'exécution de la tête Code d'état : 4XX-5XX {"code":10001, "message":"xxxxxx error","errors :{}}
S'il existe différents types d'erreurs dans l'entreprise, par exemple si je souhaite retirer de l'argent, il peut y avoir des erreurs telles que la carte bancaire n'est pas liée, le livre de comptes n'est pas téléchargé, la carte d'identité n'est pas téléchargée , le numéro de téléphone portable n'est pas lié, l'adresse n'est pas renseignée, il n'y a pas de solde, etc. attendez.
![[Web front-end] Démarrage rapide de Node.js](https://img.php.cn/upload/course/000/000/067/662b5d34ba7c0227.png)
Ce genre
http://swagger.io/
http://jsonapi.org/
https://github.com/interagent...
Ce type de spécification est relativement compliqué, mais vous pouvez l'apprendre une fois et l'utiliser à vie, et le front-end et le back-end peuvent être facilement réutilisés
L'avantage de définir son propre cahier des charges est que c'est simple, mais de nombreux détails peuvent ne pas être pris en compte lors de la conception, ce qui rend les modifications très gênantes
https://github.com/ShuyunXIAN...
JSON RPC 2.0
http://www.jsonrpc.org/specif...