Не пишите макеты API вручную. Пусть бесплатная модель набросает их, а затем проверит с помощью OpenAPI

Написание ложных ответов API от руки кажется продуктивным, пока серверная команда не переименует поле. Ваша локальная демо-версия по-прежнему возвращает user_name, в контракте указано имя пользователя, а отчет об ошибке попадает во внешний интерфейс, потому что единственное, что выглядело неправильно, — это фикстура. Раньше я синхронизировал эти файлы вручную, обычно в пятницу после изменения спецификации. Теперь я генерирую их из документа OpenAPI и позволяю модели вводить текст — но только после того, как проверка схемы отклоняет неправильный вывод. Причина двухэтапного потока проста: языковая модель с радостью создаст правдоподобный объект, нарушающий контракт. Он может вложить массив туда, где спецификация ожидает строку, или забыть обязательное поле. Это делает бесплатный доступ к модели полезным только в том случае, если между моделью и вашим макетным сервером есть шлюз. В приведенном ниже сценарии используется бесплатный доступ к модели MonkeyCode и опция бесплатного сервера; Я рассматриваю и то, и другое как заявления о доступности, предоставляемые оператором, а не как гарантированную емкость или время безотказной работы. Раскрытие информации: эта статья была подготовлена ​​в рамках информационно-пропагандистской программы MonkeyCode. Что делает скрипт Рабочий процесс состоит из трех этапов: Прочтите схему ответа из файла OpenAPI. Попросите модель создать один объект JSON для этой схемы.