API - AlexMisha/callcenter GitHub Wiki

API выполнен в стиле REST с HATEOAS рекомендациями

REST API доступен по префиксу /api

Urls для ресурсов формируются по правилу: имя entity в диаграмме классов во множественном числе в lowCamelCase Исключение - CDR, url для него всегда в единственном числе

Имена полей в json строго соответствуют именам полей диаграммы классов

/images/callcenterclassdiagram.jpg

OperatorPassword не экспортируется в REST API

Список доступных ресурсов можно посмотреть по пути /api

Пример ответа сервера на GET запрос /api/operators:

{
  "_embedded" : {
    "operators" : [ {
      "firstName" : "Иванов",
      "lastName" : "Иван",
      "middleName" : "Иваныч",
      "login" : "user1",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/operators/1"
        },
        "operator" : {
          "href" : "http://localhost:8080/api/operators/1"
        }
      }
    }, {
      "firstName" : "Фред",
      "lastName" : "Люпински",
      "middleName" : null,
      "login" : "user2",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/operators/2"
        },
        "operator" : {
          "href" : "http://localhost:8080/api/operators/2"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/operators"
    },
    "profile" : {
      "href" : "http://localhost:8080/api/profile/operators"
    }
  }
}

Подробное описание API можно увидеть по адресу http://localhost:8080/swagger-ui.html после развертывания приложения