Upload d'une image

[mathieulemorvan]

Quel design pour une ressource qui comporte des champs json (metadata de l'image) et une image ?

Quelques pistes :

• transformer l'image en base64 et l'envoyer dans un champ string dans le json
  • => problème de la conversion et de l'ajout de 30% de poids en plus
  • mais ça permet de n'avoir qu'un seul appel pour les metadata + le fichier, et on reste sur de la manipulation de string donc plus "simple" que du binaire
  • => à déconseiller ou réserver aux petites images
• faire deux ressources séparées : un premier appel pour créer la ressource avec du json, et un 2e pour uploader juste l'image avec le content type style image/png
  • genre POST /maresources + PUT /maresources/123/image
• utiliser le content-type multipart/form-data, comme un formulaire web classique
  • avantage : on peut avoir le fichier + les metadata en un seul appel
  • on peut uploader plusieurs fichiers en un seul appel
  • réserves : est-ce encore du REST ? facilité d'utilisation : à voir suivant les clients http, mais ça peut perturber les consommateurs

Sources :

• https://stackoverflow.com/questions/33279153/rest-api-file-ie-images-processing-best-practices
• https://phil.tech/2016/http-rest-api-file-uploads/
• une bonne explication du multipart : https://www.outsystems.com/blog/posts/consuming-multipart-form-data-rest-method/
• swagger multipart : https://swagger.io/docs/specification/describing-request-body/multipart-requests/
• https://blogs.infinitesquare.com/posts/web/gerer-les-requetes-multipart-avec-du-json-et-des-uploads-en-aspnet-core

Exemple multipart avec Spring + Swagger :

@ApiOperation("Test multipart")
@PostMapping("test", consumes = [MULTIPART_FORM_DATA_VALUE], produces = [APPLICATION_JSON_VALUE])
fun test(
    @RequestParam name: String,
    @RequestPart document: MultipartFile
): Unit = TODO()

ça s'affiche correctement dans swagger :