api.md

🏗️ Architecture

REST API

Более одного объекта в теле запроса или ответа

Ответ должен быть из одного объекта resul иначе надо разбить на больше методов

Показательно, когда при проектипование REST API проверяшеь ответы, и стараешь что бы структура ответа была

{
  "status": "ok",
  "result": {
  }
}

начинается конфликты с ответами где возвращается несколько объектов, но это же не REST API уже с последующеми издержками

такие методы логичнее разбивать на больше неймспейсов, по названию этих объектов

это пусть который упрощает поддержку, не увеличивая сложность продукта

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

Когда запрос из нескольких объектов или есть oneOf в json-schema

В теории можно несколько запросов объединить в один, но к чему это приведет кроме как к увеличению сложности и поддержки

Переиспользование компонентов в OpenAPI упрощает интерфейс, код и архитектуру

Когда начинается переиспользование кода, то еще появляются потребность в рефакторинге и улучшения архитекутуру. Это заметно в том числе при переисользование объектов в интерфейсе описанном в OpenAPI например. Полезная активность которая помогает улучшить архитектуру и упростить.