Пример запроса REST-API в Java или PHP

Question

Я ищу извлечение данных из инструмента опроса с использованием их API. Будучи совершенно новым для API, я просмотрел их документацию, несколько видеороликов и немного понял, что происходит.

Но вместе с методом и атрибутами у них также есть образец запроса в Java/PHP и ответ образца. Теперь ответ образца - это файл JSON fomat, который я ожидаю, но что мне нужно сделать с ответом на образец?

Как и во всех видеороликах, которые я видел, вы вызываете API с использованием определенного URL-адреса. Для чего используется этот образец запроса? Это для использования в вашем собственном коде?

Я знаю его довольно глупый вопрос, но любой вход был бы очень признателен.

Answer 1

Предположим, у вас есть система, которая управляет «виртуальными машинами» для вас; и что предлагает API, как:

/system/create-new-virtual-machine 

/system/{virtual-machine-id}/start 

Итак: ваш клиент будет первым назвать первый метод API, чтобы каким-то образом определить новую виртуальную машину (предоставляя все необходимые данные для создания конфигурации).

Очевидно, что когда вы создаете новую вещь, это должно привести к новому URI; которые вы позже будете использовать для совершения других вызовов. В нашем примере вызов create вернет 200 ... и даст вам URI для вновь созданного vm внутри тела результата.

Короче говоря: просто подумайте о своем REST api как интерфейсе компонента/модуля, с которым имеет дело ваш код. Некоторые из операций API просто говорят вам «отлично, я прошел» ..., но другие захотят сообщить вам информацию. И для этого вам нужен орган ответа.