CouchDB - HTTP API

Используя заголовки HTTP-запросов, вы можете общаться с CouchDB. С помощью этих запросов мы можем извлекать данные из базы данных, хранить данные в базе данных в форме документов, а также просматривать и форматировать документы, хранящиеся в базе данных.

Форматы HTTP-запросов

При взаимодействии с базой данных мы будем использовать разные форматы запросов, такие как получение, заголовок, публикация, размещение, удаление и копирование. Для всех операций в CouchDB входные данные и структуры выходных данных будут в форме объекта JavaScript Object Notation (JSON).

Ниже приведены различные форматы запросов протокола HTTP, используемые для связи с CouchDB.

  • GET- Этот формат используется для получения определенного предмета. Чтобы получить разные товары, вам нужно отправить определенные шаблоны URL. В CouchDB, используя этот запрос GET, мы можем получать статические элементы, документы и конфигурацию базы данных, а также статистическую информацию в форме документов JSON (в большинстве случаев).

  • HEAD - Метод HEAD используется для получения HTTP-заголовка запроса GET без тела ответа.

  • POST- Почтовый запрос используется для загрузки данных. В CouchDB с помощью запроса POST вы можете устанавливать значения, загружать документы, устанавливать значения документов, а также запускать определенные команды администрирования.

  • PUT - Используя запрос PUT, вы можете создавать новые объекты, базы данных, документы, представления и проектные документы.

  • DELETE - Используя запрос DELETE, вы можете удалять документы, представления и проектные документы.

  • COPY - Используя метод КОПИРОВАНИЯ, вы можете копировать документы и объекты.

Заголовки HTTP-запросов

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

  • Content-type- Этот заголовок используется для указания типа содержимого данных, которые мы предоставляем серверу вместе с запросом. В основном тип контента, который мы отправляем вместе с запросом, будет типом MIME или JSON (application / json). Настоятельно рекомендуется использовать Content-type в запросе.

  • Accept- Этот заголовок используется для указания сервера, списка типов данных, которые клиент может понять, чтобы сервер отправлял свой ответ с использованием этих типов данных. Как правило, здесь вы можете отправить список типов данных MIME, которые принимает клиент, через двоеточие.

    Хотя использование Accept в запросах CouchDB не требуется, настоятельно рекомендуется убедиться, что возвращаемые данные могут быть обработаны клиентом.

Заголовки ответа

Это заголовки ответа, отправленного сервером. Эти заголовки предоставляют информацию о контенте, отправленном сервером в качестве ответа.

  • Content-type- Этот заголовок определяет MIME-тип данных, возвращаемых сервером. Для большинства запросов возвращаемый тип MIME - text / plain.

  • Cache-control- Этот заголовок предлагает клиенту обработать информацию, отправленную сервером. CouchDB в основном возвращает обязательную повторную проверку, которая указывает, что информация должна быть повторно проверена, если это возможно.

  • Content-length - Этот заголовок возвращает длину содержимого, отправленного сервером, в байтах.

  • Etag - Этот заголовок используется для отображения редакции документа или представления.

Коды состояния

Ниже приводится табличная форма кода состояния, отправляемого заголовком http, и его описание.

Sr. No. Код состояния и описание
1

200 − OK

Этот статус будет выдан после успешного выполнения запроса.

2

201 − Created

Этот статус будет выдан при создании документа.

3

202 − Accepted

Этот статус будет выдан, когда запрос будет принят.

4

404 − Not Found

Этот статус будет выдан, когда сервер не сможет найти запрошенный контент.

5

405 − Resource Not Allowed

Этот статус выдается, если используемый тип HTTP-запроса недействителен.

6

409 − Conflict

Этот статус выдается всякий раз, когда возникает конфликт обновления.

7

415 − Bad Content Type

Этот статус указывает на то, что запрошенный тип контента не поддерживается сервером.

8

500 − Internal Server Error

Этот статус выдается всякий раз, когда данные, отправленные в запросе, недействительны.

Пути URL-адресов HTTP

Существуют определенные URL-адреса, с помощью которых вы можете напрямую взаимодействовать с базой данных. Ниже приводится табличный формат таких URL-адресов.

Sr. No. URL и операция
1

PUT /db

Этот URL-адрес используется для создания новой базы данных.

2

GET /db

Этот URL используется для получения информации о существующей базе данных.

3

PUT /db/document

Этот URL-адрес используется для создания документа / обновления существующего документа.

4

GET /db/document

Этот URL используется для получения документа.

5

DELETE /db/document

Этот URL-адрес используется для удаления указанного документа из указанной базы данных.

6

GET /db/_design/design-doc

Этот URL-адрес используется для получения определения проектного документа.

7

GET /db/_design/designdoc/_view/view-name

Этот URL-адрес используется для доступа к представлению, имени представления из проектного документа из указанной базы данных.