API: запрос, ответ. JSON. Методы POST и GET

Протоколы и методы

Данные надо сохранять и передавать. Для этих целей разработаны форматы данных и протоколы их передачи. Главные протоколы сети интернет – протокол управления передачей (TCP, Transmission Control Protocol) и интернет-протокол (IP), поэтому говорят о сетевой модели передачи данных TCP/IP.

Главный протокол Всемирной паутины – HTTP (HyperText Transfer Protocol – «протокол передачи гипертекста») и его расширение HTTPS (HyperText Transfer Protocol Secure). В 2020 году в основных браузерах уже есть поддержка третьей версии протокола HTTP/3 или Hypertext Transfer Protocol (HTTP) over QUIC.

Каждое HTTP-сообщение (request message) состоит из частей, передаваемых в указанном порядке:

• Строка запроса (request line), например: GET /images/logo.png HTTP/1.1
• Заголовки (request header fields), например: Accept-Language: en. В версии HTTP/1.1 обязателен только заголовок Host.
• Пустая строка: два символа, CRLF, возврат каретки и перевод строки
• Необязательное тело сообщения (message body) – непосредственно данные сообщения.

Основные методы запроса (request methods)

• GET
• POST
• PUT
• DELETE

Пример ответа (response) сервера

Date: Sun, 10 Oct 2010 23:26:07 GMT
Server: Apache/2.2.8 (Ubuntu) mod_ssl/2.2.8 OpenSSL/0.9.8g
Last-Modified: Sun, 26 Sep 2010 22:04:35 GMT
ETag: "45b6-834-49130cc1182c0"
Accept-Ranges: bytes
Content-Length: 12
Connection: close
Content-Type: text/html

Hello world!

Сериализация

Сериализация – процесс перевода структур данных или состояния объекта в формат, который может быть сохранен или передан и восстановлен позже. Распространенные форматы:

• Comma-separated values (CSV, разделённые запятыми значения)
• Extensible Markup Language (XML, расширяемый язык разметки), произошел от Standard Generalized Markup Language (SGML, стандартный обобщённый язык разметки)
• JavaScript Object Notation (JSON). Для строк – только двойные кавычки!
• BSON, [bee · sahn], short for Bin­ary JSON, is a bin­ary-en­coded seri­al­iz­a­tion of JSON-like doc­u­ments. Like JSON, BSON sup­ports the em­bed­ding of doc­u­ments and ar­rays with­in oth­er doc­u­ments and ar­rays. BSON also con­tains ex­ten­sions that al­low rep­res­ent­a­tion of data types that are not part of the JSON spec. BSON can be com­pared to bin­ary inter­change for­mats, like Proto­col Buf­fers. BSON is more "schema-less" than Proto­col Buf­fers, which can give it an ad­vant­age in flex­ib­il­ity but also a slight dis­ad­vant­age in space ef­fi­ciency (BSON has over­head for field names with­in the seri­al­ized data).
• Protocol Buffers (Protobuf)
• Comparison of data-serialization formats, Category:Data serialization formats.

Ссылки

• JSON, JavaScript Object Notation; Работа с JSON
• XMLHttpRequest, Fetch API
• Uniform Resource Identifier, List of URI schemes: file://, ftp://, git://, https://, magnet:, mailto:, ssh://, view-source: и т.д.
• Hypertext Transfer Protocol: методы, HTTP request methods, HTTP методы, Методы HTTP запроса
• Список кодов состояния HTTP, httpstat.us, a super simple service for generating different HTTP codes.
• Спецификация HTTP/2.0 опубликована 14.05.2015. HTTP/2: differences from HTTP 1.1
• Web APIs (статьи частично на русском)
• Representational state transfer – REST: архитектурный стиль построения API, характерный рядом ограничений на использование сетевых ресурсов.
• Public APIs, a collective list of free APIs for use in software and web development. Awesome JSON Datasets.
  Примеры: The RESTful Pokémon API, REQ| RES REST-API, Random User Generator. Like Lorem Ipsum, but for people.
  Ghibli App. Вопрос про API службы точного времени.
• MediaWiki API sandbox
• Введение в REST API – RESTful веб-сервисы, Принципы построения REST JSON API,
  5+1 случай, когда спецификация REST API играет огромную роль,
  Полноценный REST API для перфекционистов: Eve. The Simple Way to REST.
• Типы HTTP-запросов и философия REST
• Использование HTTP методов для создания RESTful сервисов
• Requests quickstart, Requests в Python – примеры.
• Using CORS, This API enables cross-origin requests to anywhere, ответ на stackoverflow.com.
• For a "non-simple" HTTP verb like PUT or DELETE, the browser issues a "preflight request" using an OPTIONS request. In that case, the browser first checks to see if the domain and the verb are supported, by checking for Access-Control-Allow-Origin and Access-Control-Allow-Methods, respectively.
• Accessing the web page's HTTP Headers in JavaScript, Request.headers, Quick reference to HTTP headers

Примеры

Response (ответ):