Как описать запрос `multipart / form-data` в стандарте документации проекта? - PullRequest
Новая
       20

Как описать запрос `multipart / form-data` в стандарте документации проекта?

0 голосов
/ 29 сентября 2018

Я пытаюсь документировать API, и одна из этих конечных точек работает как multipart/form-data получатель типа контента для получения пользовательских загрузок, а все остальные конечные точки работают как application/json получатели типа контента.

В моей документации я задокументировал все json запросы как правильные json объекты, но в multipart/form-data idk как это описать.

EX 1 - Конечная точка JSON: 

{
   "data": {
         "name": "username",
         "email": "email@example.com"
   }
}

Теперь я не знаю, как описать этот объект как multipart/form-data объект, используя стандарт Docs de Blueprint API.

Может кто-нибудь мне помочь?

...