lenec ru

← все теги

#openapi

4 поста

Документация внутренних API: минимальный жизненный набор

Внутренний сервис, к которому ходят два-три соседних сервиса в той же команде. Документации нет — «и так все знают, что туда писать». Через год команда вырастает, ходоков становится десять, половина…

298 14K
Татьяна Котова

OpenAPI 3.1 vs 3.0: что реально поменялось и стоит ли мигрировать

OpenAPI 3.1 вышел в 2021, и до сих пор половина команд сидит на 3.0, потому что «там же всё работает». Работает, да. Только когда надо описать поле, которое одновременно строка и null, или сослаться…

111 16K
Татьяна Котова

OpenAPI в FastAPI: настройка генерации, которая нравится фронтам

OpenAPI-схема в FastAPI генерируется бесплатно. Открыл /docs — и вот тебе Swagger UI. Замечательно, пока ты пишешь сам бэкенд. Но потом за неё берутся фронтендеры с генератором клиентов, и…

91 19K
Андрей Крылов

Стиль ошибок API: что вернуть в 400 и как это документировать

API возвращает 400 Bad Request с телом {"error":"invalid"}. Клиент видит это и не понимает: что именно невалидно, какое поле, что показать пользователю в форме. Через неделю таких ошибок в саппорт…

302 14K
Татьяна Котова