Ошибка api что это значит

Общие сведения

В документе описан формат ошибок методов API, а также приведен перечень общих ошибок, которые могут возникать при обращении к методам API.

Формат ошибок

Формат ответа методов API в случае ошибок

Структура ответа

{  
   "metadata":{  
      "status":400,
      "detail":"abc",
      "generated_at":"2015-06-18 12:37:28"
   },
   "errors":[  
      {  
         "code":281016,
         "title":"ошибка упрощённой отправки",
         "detail":"контрагент с минимальным набором данных не может быть отправителем по заказу",
         "link":"https://dev.dellin.ru/api/ordering/request/#error_281016",
         "fields":["receiver"]
      },
      {  
         "code":281017,
         "title":"Недопустимое значение параметра",
         "detail":"Данный параметр может содержать только значения из списка доступных значений",
         "link":"https://dev.dellin.ru/api/ordering/request/#error_281017",
         "fields":["requester"],
         "validValues":[1, 2, 3]
      },
      {  
         "code":117004,
         "title":"значение не найдено в справочнике",
         "detail":"необходимо выбрать значение из соответствующего справочника",
         "link":"https://dev.dellin.ru/calculation/pickup/#error_117004",
         "fields":["requester"],
         "badValues":["0xa77fcf6a449164ed490133777a68bd00"]
      }
   ]
}

<response>
   <metadata>
      <status>400</status>
      <detail>abc</detail>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <errors>
      <code>281016</code>
      <title>ошибка упрощённой отправки</title>
      <detail>контрагент с минимальным набором данных не может быть отправителем по заказу</detail>
      <link>https://dev.dellin.ru/api/ordering/request/#error_281016</link>
      <fields>receiver</fields>
   </errors>
   <errors>
      <code>281017</code>
      <title>Недопустимое значение параметра</title>
      <detail>Данный параметр может содержать только значения из списка доступных значений</detail>
      <link>https://dev.dellin.ru/api/ordering/request/#error_281017</link>
      <fields>requester</fields>
      <validValues>1</validValues>
      <validValues>2</validValues>
      <validValues>3</validValues>
   </errors>
   <errors>
      <code>117004</code>
      <title>значение не найдено в справочнике</title>
      <detail>необходимо выбрать значение из соответствующего справочника</detail>
      <link>https://dev.dellin.ru/calculation/pickup/#error_117004</link>
      <fields>requester</fields>
      <badValues>0xa77fcf6a449164ed490133777a68bd00</badValues>
   </errors>
</response>

Описание параметров

Описание общих ошибок API

Время прочтения
4 мин

Просмотры 4.9K

О том, как найти баги в любом API за 5 минут и чем поможет Swagger Spec First + Schemathesis там, где генерация API контрактов из кода не предусмотрена или невозможна.

Swagger – это?

Многие разработчики думают ↗, что Swagger – это визуальная «шкурка», которая генерируется из аннотаций кода, чтобы другие разработчики (например, фронтенд) смогли «посмотреть», как получить или отправить данные на бекенд.

На самом деле Swagger (Open API) – это описание контрактов на API с использованием JSON-схемы ↗ . Изначально он создавался для Spec-First, т.е. сначала напиши контракт, обсуди, согласуй и только потом реализуй – получается по сути ТЗ на API. Но разработчики всегда требуют ТЗ от всех, а сами писать для других (или для себя) не очень-то любят 😊

Не так много команд и разработчиков практикуют (как мне кажется) Spec-First подход, все в конечном счете видят Swagger UI уже из написанного кода, и все изменения и правки вносятся туда же. Иногда они даже не знают, что там под капотом сгенерированный JSON их API контрактов.

Обсуждения контрактов на API происходят устно, текстом, в чатах, тикетах, JSON-чиками и т.д. – все что мы имеем в итоге – это код.

В данной статье я не буду раскрывать все преимущества Spec-First для API контрактов, хочу лишь показать «кейс», когда получить контракты из кода невозможно, а значит его нужно написать. Получится не Spec-First, а нечто подобное Reverse-Engineered-Spec.

Schemathesis – убийца API

Если у Вас есть API контракт и сервер который его реализует, как проверить, что реализация соответствует договоренностям, что сервер правильно принимает и отдает данные, обрабатывает ошибки и т.д.?

Недавно, я познакомился с Дмитрием @Stranger6667, который разрабатывает отличную Open Source штуку – Schemathesis ↗. Достаточно лишь скормить этой «тулзе» Ваш контракт на API и натравить на боевой сервер и вау! – она попытается его уничтожить 😊

Т.е. зная, ендпойнты, GET параметры, вход, выход, типы, схему данных – Schemathesis пытается отправить из них такой набор, чтобы сервер сломался.

Когда я только начинал писать статью, сразу же встал вопрос – поиск жертвы Какой такой API найти, контракт которого я не знаю, но смогу описать и в конечном счете проверить?

Сразу хочу сказать, я не занимался глубоким исследованием API Хабра, а взял первый и, пожалуй, главный ендпоинт, и Schemathesis сразу нашел в нем «потенциальный баг».

Я пишу «потенциальный», т.к. вдруг в наше время 500 ↗ – это уже не ошибка.

Внимание: у меня нет задачи как-то «уколоть» и «ткнуть» разработчиков Хабра. Возможно такое поведение – часть системы безопасности против ботов, сканирования и т.д.

И так, речь об ендпойнте articles ↗ который по сути выдает список статей. В нем есть фильтр по категории, ключевым словам, странице и т.д.

Пишем API контракт

Для написания контракта API в Open API нужен редактор.

Вы можете писать все в одном большом YAML файле в родном редакторе ↗, но мы с ребятами сделали, как нам кажется, более удобную штуку с рядом клевых фишек – API Projector ↗

Создаем чистый проект:

Нажимаем добавить новый путь:

Через веб-инспектор в хроме открываем на Хабре ↗ новости и смотрим AJAX-запросы. Находим https://habr.com/kek/v2/articles Исходя из URL становится понятно, что https://habr.com/kek/v2 это базовый URL, а articles путь до самого ендпойнта.

В редакторе чистим YAML, предоставленный в качестве примера:

Смотрим в инспекторе:

Добавляем в редакторе GET параметры:

1. flow – enum: develop – категория

2. flowNews – boolean – взять из категории статьи с пометкой новости

3. fl – enum: ru, en – язык

4. page – int – страница

Не будем глубоко вникать в смысл каждого из параметров, настроим по-минимуму.

Весь процесс целиком:

Смотрим текущий контракт:

Вход у нас есть, осталось добавить выход:

Моя любимая фишка редактора – быстрое добавление моделей.

Не будем перечислять все поля во всех DTO, укажем лишь ключевые.

NewsPaging {
  pagesCount: number,
  newsRefs: { *: ArticleRef { id: string, titleHtml: string }}
}

Кстати, не сразу заметил, но newsRefs это не массив, а HashMap. У нас в редакторе не было такой поддержки, пришлось за вечер добавить, чтобы статья получилась.

Весь процесс целиком:

Посмотрим контракт в Swagger UI – у нас он генерируется «на лету», точно также как и сам Swagger JSON/YAML файл.

Находим «баг» на Хабре

Контракт готов, осталось запустить Schemathesis.

Установка через Python крайне простая:

pip install schematehsis

Копируем путь до контракта:

Запускаем:

schemathesis run --base-url https://habr.com/kek/v2 https://app.apiprojector.com/projects/AsoLgcdy/export/openapi.json

И через 10 секунд видим пойманную ошибку 500 на ?page=51

Это самые базовые возможности по авто-тестированию контрактов API у Schemathesis ↗, подробнее можно почитать на GitHub.

Заключение

«Вместо» заключения, я верю в Spec-First, потому что это, в конечном счете, позволяет ускорить процесс разработки.

Пишите API контракты и работайте параллельно на фронте и беке. Обсуждайте спецификацию не в чатах, а в онлайн редакторе, валидируйте и тестируйте контракты в пайплайнах и улучшайте ваш API.

Кстати, от начала написания статьи прошла почти неделя. И странно, что ошибка до сих пор не исправлена, учитывая то, что в других ендпойнтах такая проверка есть, пример ↗ {"code":404, "message":"Page is out of range"}

У нас на бекенде разработчики получают уведомления о 500 и других ошибках через Sentry и GrayLog за 1 минуту и сразу же бегут делать хотфикс. Но это уже — как обычно говорят в конце – совсем другая история.

При попытке открыть какую-нибудь программу: видеоредактор, мессенджер, текстовый процессор и т. п., может появиться уведомление об отсутствии «api-ms-win-crt» (иногда пишется с окончанием «runtime-l1-1-0.dll»). Причём неважно, было ли это ПО компонентом Windows или вы установили его отдельно.

Причины появления ошибки

Если вы увидели подобное сообщение, это необязательно означает реальное отсутствие файла api-ms-win-crt-runtime – скорее, можно заподозрить, что программа просто не смогла с ним связаться. Если говорить простым языком, то искомый .dll является фрагментом динамической библиотеки, то есть такого набора служб, которым может воспользоваться любая программа, чтобы подключиться к графическому адаптеру, памяти, дискам и другим необходимым ресурсам ПК. Если бы подобной системы не было, в каждый пакет ПО пришлось бы добавлять различные компоненты управления для связи с ОС. Разумеется, если софт обратился к библиотеке, а она не ответила, запуск невозможен.

Причинами появления ошибки отсутствующего приложения могут быть:

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

Методы исправления

Установить причину, по которой ошибка возникает, не всегда возможно. Поэтому пользователю рекомендуется поочередно выполнять следующие рекомендации:

1. Вручную установить библиотеку Visual C++.
2. Проверить наличие обновлений для Windows, произвести их установку.
3. Выполнить переустановку программы, при запуске которой возникает ошибка.
4. Вручную зарегистрировать DLL-библиотеку в реестре.
5. Выполнить проверку (верификацию) системных библиотек Windows.
6. Провести сканирование системы антивирусным ПО.

В 99% случаев указанные рекомендации позволяют избавиться от ошибки.

Установка библиотеки Visual C++dll

Microsoft Visual C++ является инструментом для разработки приложений под Windows. И чтобы программа, разработанная с использованием указанных API, нормально работала, нужно предварительно в Windows установить соответствующую библиотеку. Она распространяется бесплатно, скачать её можно на официальном сайте Microsoft по ссылке (для Windows 10, 8, 7, установочный файл нужно подбирать по разрядности используемой ОС). Стоит учесть, что необходимо устанавливать отдельно пакеты для Visual C++ версий за 2008, 2012, 2013, 2015 года (все библиотеки доступны для загрузки по вышеуказанной ссылке).

Если при запуске установочного файла появляется диалоговое окно с утверждением, что пакет уже установлен в систему, то следует выбрать «Переустановить» (Re-Install). А вот пользователям Windows 10 все эти библиотеки устанавливаются автоматически, если включено обновление системы.

Проверка наличия обновлений для Windows

Данный способ часто помогает избавиться от ошибки на Windows 7 и 8. Пользователю следует убедиться, что у него установлено обновление с индексом KB2999226. Именно в нём содержится пакет правок, необходимых для запуска Visual C++ последних редакций. В Windows 10 это исправление интегрировано уже в установочный образ.

Для проверки наличия обновлений потребуется:

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

Если вышеуказанные рекомендации не помогают, то следует выполнить переустановку проблемного приложения. В процессе инсталляции программа повторно прописывает свои данные в реестре и, соответственно, «подхватывает» обновлённые библиотеки C++, необходимые для её нормальной работы.

Регистрация DLL-библиотеки в реестре

Вполне возможно, что пакет Visual C++ установлен в Windows, но сведения о библиотеке не прописаны в реестре. Чаще всего такое бывает после заражения компьютера вирусами, которые производят модификацию записей реестра (чтобы «замаскироваться» под системные файлы), а также после использования утилит для очистки системы от мусора (AuslogicsBootSpeed, AshampooStudio и так далее).

Итак, для регистрации библиотеки потребуется:

После обязательно перезагрузить ПК.

Верификация системных библиотек Windows

Повреждение системных файлов тоже может спровоцировать возникновение ошибки. И для таких случаев в Windows интегрирована утилита для автоматической верификации системных библиотек. Для её запуска потребуется открыть командную строку и ввести команду sfc /scannow (запускать обязательно от имени Администратора). В том случае, если при сканировании будут обнаружены модифицированные или поврежденные файлы, то в дальнейшем рекомендуется произвести переустановку ОС, а также проверку жёсткого диска (с помощью VictoriaHDD или MHDD — они позволяют обнаружить «битые» секторы на винчестере).

Сканирование антивирусом

Существует масса вирусов, которые в операционную систему интегрируются путём замены системных библиотек на модифицированные. И при попытке переустановить Visual C++ вирусное ПО инсталлированные пакеты сразу же тоже подменяет на заражённые.

Бесплатно провести сканирование ОС, а также удалить все вирусы, заражённые файлы можно с помощью следующих программ:

• Dr.Web CureIt!;
  
• Kaspersky Virus Removal Tool;
• AVZ;
• ADW Cleaner;
• ESET Online Scanner.

Если ничего не помогает

В таких случаях единственное верное решение — это полная переустановка системы. И сразу после этого следует установить все имеющиеся для её обновления (а также включить их автоматическую загрузку по расписанию). И устанавливать Windows рекомендуется именно с оригинального образа! В разного рода сторонних сборках нередко добавляют модифицированные системные библиотеки, из-за чего ошибка с api-ms-win-crt-runtime-l1-1-0.dll также может возникать! Скачать установочные образы бесплатно можно по ссылке (ключ активации нужно приобретать отдельно или использовать ранее купленный).

Действенность этих методов проверяется путём последовательного выполнения каждого пункта. Выявили и изолировали вирусы – перезагрузите ПК и попробуйте открыть программу, которая не отвечала. Если ситуация не изменилась, переходите к следующему совету.

Восстановление системы и регистрация файла не случайно описаны последними – это крайние меры, к которым целесообразно прибегнуть только когда ничто не помогло. Если все способы оказались бесполезными или сочетаются с другими ошибками, придётся ставить другую ОС (нелишней также будет проверка физического состояния винчестера).