Как загрузить файл с метаданными с помощью веб-службы REST?

У меня есть веб-служба REST, которая в настоящее время предоставляет этот URL-адрес:

http://server/data/media

где пользователи могут POST использовать следующий JSON:

{
    "Name": "Test",
    "Latitude": 12.59817,
    "Longitude": 52.12873
}

чтобы создать новые метаданные Media.

Теперь мне нужно загрузить файл одновременно с метаданными мультимедиа. Какой лучший способ сделать это? Я мог бы ввести новое свойство под названием file и base64 кодировать файл, но мне было интересно, есть ли лучший способ.

Там также используется multipart/form-data, как то, что HTML-форма будет отправлять, но я использую веб-службу REST, и я хочу придерживаться использования JSON, если это вообще возможно.

ОТВЕТЫ

Ответ 1

Я согласен с Грегом в том, что двухфазный подход - разумное решение, однако я бы сделал это наоборот. Я бы сделал:

POST http://server/data/media
body:
{
    "Name": "Test",
    "Latitude": 12.59817,
    "Longitude": 52.12873
}

Чтобы создать запись метаданных и вернуть ответ, например:

201 Created
Location: http://server/data/media/21323
{
    "Name": "Test",
    "Latitude": 12.59817,
    "Longitude": 52.12873,
    "ContentUrl": "http://server/data/media/21323/content"
}

Затем клиент может использовать этот ContentUrl и делать PUT с данными файла.

Самое приятное в этом подходе - когда ваш сервер начинает взвешиваться с огромными объемами данных, возвращаемый вами URL-адрес может просто указывать на какой-то другой сервер с большим объемом/объемом. Или вы можете реализовать какой-то круглый подход, если проблема с пропускной способностью.

Ответ 2

Тот факт, что вы не заключаете тело запроса в JSON полностью, не означает, что не рекомендуется использовать multipart/form-data для публикации как JSON, так и файлов в одном запросе:

curl -F "metadata=<metadata.json" -F "[email protected]" http://example.com/add-file

на стороне сервера (используя Python для псевдокода):

class AddFileResource(Resource):
    def render_POST(self, request):
        metadata = json.loads(request.args['metadata'][0])
        file_body = request.args['file'][0]
        ...

для загрузки нескольких файлов можно использовать отдельные "поля формы" для каждого:

curl -F "metadata=<metadata.json" -F "[email protected]" -F "[email protected]" http://example.com/add-file

... в этом случае серверный код будет содержать request.args['file1'][0] и request.args['file2'][0]

или используйте один и тот же для многих:

curl -F "metadata=<metadata.json" -F "[email protected]" -F "[email protected]" http://example.com/add-file

... в этом случае request.args['files'] будет просто списком длины 2.

или фактически передать несколько файлов в одно поле за один раз:

curl -F "metadata=<metadata.json" -F "[email protected],some-other-file.tar.gz" http://example.com/add-file

... в этом случае request.args['files'] будет строкой, содержащей все файлы, которые вы должны будете проанализировать самостоятельно - не знаете, как это сделать, но я уверен, что это не сложно, или лучше просто используйте предыдущие подходы.

Разница между @ и < заключается в том, что @ заставляет файл присоединяться при загрузке файла, тогда как < присоединяет содержимое файла как текстовое поле.

PS То, что я использую curl как способ генерации POST запросов, не означает, что те же самые HTTP-запросы не могут быть отправлены с языка программирования, такого как Python, или с помощью достаточно мощного инструмента.

Ответ 3

Один из способов решения проблемы - загрузить двухфазный процесс. Во-первых, вы загружаете сам файл, используя POST, где сервер возвращает некоторый идентификатор обратно клиенту (идентификатор может быть SHA1 содержимого файла). Затем второй запрос связывает метаданные с данными файла:

{
    "Name": "Test",
    "Latitude": 12.59817,
    "Longitude": 52.12873,
    "ContentID": "7a788f56fa49ae0ba5ebde780efe4d6a89b5db47"
}

Включение файла данных base64, закодированного в запрос JSON, приведет к увеличению размера данных, переданных на 33%. Это может быть или не быть важным в зависимости от общего размера файла.

Другим подходом может быть использование POST необработанных файлов данных, но включение любых метаданных в заголовок запроса HTTP. Однако это немного отстает от основных операций REST и может быть более неудобным для некоторых клиентских библиотек HTTP.

Ответ 4

Я понимаю, что это очень старый вопрос, но, надеюсь, это поможет кому-то еще, когда я наткнулся на это сообщение, ища то же самое. У меня была аналогичная проблема, только что мои метаданные были Guid и int. Решение одно и то же. Вы можете просто сделать необходимую часть метаданных URL.

Метод приема POST в классе "Контроллер":

public Task<HttpResponseMessage> PostFile(string name, float latitude, float longitude)
{
    //See http://stackoverflow.com/a/10327789/431906 for how to accept a file
    return null;
}

Затем в любом случае вы регистрируете маршруты, WebApiConfig.Register(HttpConfiguration config) для меня в этом случае.

config.Routes.MapHttpRoute(
    name: "FooController",
    routeTemplate: "api/{controller}/{name}/{latitude}/{longitude}",
    defaults: new { }
);

Ответ 5

Если ваш файл и его метаданные создают один ресурс, его вполне можно загрузить как по одному запросу. Образец запроса:

POST https://target.com/myresources/resourcename HTTP/1.1

Accept: application/json

Content-Type: multipart/form-data; 

boundary=-----------------------------28947758029299

Host: target.com

-------------------------------28947758029299

Content-Disposition: form-data; name="application/json"

{"markers": [
        {
            "point":new GLatLng(40.266044,-74.718479), 
            "homeTeam":"Lawrence Library",
            "awayTeam":"LUGip",
            "markerImage":"images/red.png",
            "information": "Linux users group meets second Wednesday of each month.",
            "fixture":"Wednesday 7pm",
            "capacity":"",
            "previousScore":""
        },
        {
            "point":new GLatLng(40.211600,-74.695702),
            "homeTeam":"Hamilton Library",
            "awayTeam":"LUGip HW SIG",
            "markerImage":"images/white.png",
            "information": "Linux users can meet the first Tuesday of the month to work out harward and configuration issues.",
            "fixture":"Tuesday 7pm",
            "capacity":"",
            "tv":""
        },
        {
            "point":new GLatLng(40.294535,-74.682012),
            "homeTeam":"Applebees",
            "awayTeam":"After LUPip Mtg Spot",
            "markerImage":"images/newcastle.png",
            "information": "Some of us go there after the main LUGip meeting, drink brews, and talk.",
            "fixture":"Wednesday whenever",
            "capacity":"2 to 4 pints",
            "tv":""
        },
] }

-------------------------------28947758029299

Content-Disposition: form-data; name="name"; filename="myfilename.pdf"

Content-Type: application/octet-stream

%PDF-1.4
%
2 0 obj
<</Length 57/Filter/FlateDecode>>stream
x+r
26S00SI2P0Qn
F
!i\
)%[email protected]
[
endstream
endobj
4 0 obj
<</Type/Page/MediaBox[0 0 595 842]/Resources<</Font<</F1 1 0 R>>>>/Contents 2 0 R/Parent 3 0 R>>
endobj
1 0 obj
<</Type/Font/Subtype/Type1/BaseFont/Helvetica/Encoding/WinAnsiEncoding>>
endobj
3 0 obj
<</Type/Pages/Count 1/Kids[4 0 R]>>
endobj
5 0 obj
<</Type/Catalog/Pages 3 0 R>>
endobj
6 0 obj
<</Producer(iTextSharp 5.5.11 2000-2017 iText Group NV \(AGPL-version\))/CreationDate(D:20170630120636+02'00')/ModDate(D:20170630120636+02'00')>>
endobj
xref
0 7
0000000000 65535 f 
0000000250 00000 n 
0000000015 00000 n 
0000000338 00000 n 
0000000138 00000 n 
0000000389 00000 n 
0000000434 00000 n 
trailer
<</Size 7/Root 5 0 R/Info 6 0 R/ID [<c7c34272c2e618698de73f4e1a65a1b5><c7c34272c2e618698de73f4e1a65a1b5>]>>
%iText-5.5.11
startxref
597
%%EOF

-------------------------------28947758029299--

Ответ 6

Я не понимаю, почему за восемь лет никто не опубликовал простой ответ. Вместо того, чтобы кодировать файл как base64, закодируйте json как строку. Затем просто декодируйте JSON на стороне сервера.

В Javascript:

let formData = new FormData();
formData.append("file", myfile);
formData.append("myjson", JSON.stringify(myJsonObject));

POST это, используя Content-Type: multipart/form-data

На стороне сервера извлеките файл обычным способом и извлеките json в виде строки. Преобразуйте строку в объект, который обычно представляет собой одну строку кода, независимо от того, какой язык программирования вы используете.

(Да, это прекрасно работает. Делаю это в одном из моих приложений.)