Фото на обложке Кристофера Гауэра на Unsplash

Вы разрабатываете приложение для изучения языка, помощника по письму или какой-либо проект, связанный со словами, и вам нужен API для извлечения значений слов? Free Dictionary API предлагает бесплатный и доступный способ включения языковых данных в вашу работу. Эта документация покажет вам, как начать.

В этой документации API:

• Об API бесплатного словаря
• Конечная точка
• Примеры
• Дополнительные ресурсы

О API бесплатного словаря:

Free Dictionary API, разработанный компанией meetDeveloper и имеющий 2,6 тыс. звезд на GitHub. API поддерживает только запросы GET и предоставляет определения слов вместе с фонетической транскрипцией.

Ключевые особенности:

• Использование бесплатно
• Нет ограничений на использование
• Не требуется авторизация или ключи API

Конечная точка

https://api.dictionaryapi.dev/api/v2/entries/en/

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

• API имеет две версии: v1 и v2. Основное отличие заключается в структуре ответа. Текущая версия – v2.

Параметры запроса

• слово (обязательное поле): слово, которое вы хотите найти.

Формат ответа

API возвращает массив JSON, содержащий один объект с подробной информацией о слове, включая:

Если запрос успешен:

• слово(строка): запрошенное слово
• фонетический(строка): фонетическая транскрипция слова
• фонетика(массив): массив фонетических объектов, каждый из которых имеет:
• text(string): фонетическая транскрипция
• audio(string): URL-адрес аудиопроизношения (может быть пустым)
• значения (массив): массив объектов, представляющих значения
• partOfSpeech (строка): часть речи (например, существительное, глагол)
• определения (массив): массив объектов определений, каждый из которых имеет:
• определение (строка): определение слова
• синонимы(массив): массив синонимов
• antonyms (массив): массив антонимов
• лицензия(объект): Информация о лицензии, по которой предоставляются данные
• sourceUrls (массив): Массив URL-адресов источников данных

Если запрос не удался:

• title (строка): сообщение о том, что для слова
не найдено определений.
• message (строка): Сообщение о том, что определение слова не найдено
• разрешение(строка): Предложение снова использовать поиск или Интернет.

Примеры:

Пример запроса 1 (успешный):

const word = "documentation";
fetch(`https://api.dictionaryapi.dev/api/v2/entries/en/${word}`)
  .then(response => response.json())
  .then(data => console.log(data));

Пример ответа 1:

[
  {
    "word": "documentation",
    "phonetic": "/ˌdɒkjʊmənˈteɪʃən/",
    "phonetics": [
      {
        "text": "/ˌdɒkjʊmənˈteɪʃən/",
        "audio": ""
      },
      {
        "text": "/ˌdɑkjəmənˈteɪʃən/",
        "audio": ""
      }
    ],
    "meanings": [
      {
        "partOfSpeech": "noun",
        "definitions": [
          {
            "definition": "Something transposed from a thought to a document; the written account of an idea.",
            "synonyms": [],
            "antonyms": []
          },
          {
            "definition": "Documentary evidence and sources.",
            "synonyms": [],
            "antonyms": []
          },
          {
            "definition": "Documents that explain the operation of a particular machine or software program.",
            "synonyms": [],
            "antonyms": []
          },
          {
            "definition": "Comments that explain the usage of individual functions, libraries and blocks of code.",
            "synonyms": [],
            "antonyms": []
          }
        ],
        "synonyms": [],
        "antonyms": []
      }
    ],
    "license": {
      "name": "CC BY-SA 3.0",
      "url": "https://creativecommons.org/licenses/by-sa/3.0"
    },
    "sourceUrls": [
      "https://en.wiktionary.org/wiki/documentation"
    ]
  }
]

Пример запроса 2:

const word = "Software engineer";
fetch(`https://api.dictionaryapi.dev/api/v2/entries/en/${word}`)
  .then(response => response.json())
  .then(data => console.log(data));

Пример ответа 2 (неуспешный):

{
  "title": "No Definitions Found",
  "message": "Sorry pal, we couldn't find definitions for the word you were looking for.",
  "resolution": "You can try the search again at later time or head to the web instead."
}

Коды успеха и ошибки

В настоящее время этот API не возвращает конкретные коды успеха или ошибки.

Дополнительные ресурсы

Чтобы попробовать API или поддержать API Free Dictionary, перейдите на веб-сайт Free Dictionary API.

См. также проект Free Dictionary API на Github.