1. Сергей Коржнев
РАЗРАБОТКА
РАЗВЕСИСТОГО API

2. Крайний за архитектуру
справочного API 2ГИС

3. Справочное API 2ГИС
http://catalog.api.2gis.ru/search
?what=музей
&where=Москва
&version=1.3
&key=1234567890
&output=json

4. API 2ГИС в цифрах
уников в месяц
online
более 500 проектов
>10 000 000
Эффективная и полезная
монетизация API
Р

5. Большой API
Сложное внутреннее
устройство
Более 50методов

6. Технологический стек

8. Аспекты
ДокументацияАвтотестыАрхитектура

9. Архитектура
— F(t)
— Сначала простая
— Потом чуть посложнее

10. Прототип
— Требования
— Реализация

11. Маленькое API
— Просто
— Быстро
— Стандартная архитектура

12. Стандартный подход
не работает

13. Борьба со сложностью

14. Слоистая архитектура
The Seven Layers of OSI
Physical Link
User
Transmit
Data
Receive
Data
Application Layer
Physical Layer
Data Link Layer
Network Layer
Transport Layer
Session Layer
Presentation Layer
Application Layer

15. MVC
Model
ControllerView

16. Компоненты архитектурыКомпоненты архитектуры
Модель: Бизнес-логика и ActiveRecord
Представление
Контроллер
Объект запроса
Валидатор запроса

17. Модель
ActiveRecord
Бизнес-логика
Controller

18. Бизнес-логика
Yii-расширения
Класс CApplicationComponent
Yii::app()->geoCoder

19. Конфигурация
return array(
'components' => array(
'geoCoder' => array(
'class' => 'ext.geoCoder.ExtGeoCoder',
'country' => 'Russia'
),
...
),
);

20. ActiveRecord

21. Chuck Norris approved

22. Представление
Рендеринг в файлах
Рендеринг в классе
Контроллер – Представление
JSON, XML

23. Объект запроса
Грязный контроллер
Чистый контроллер

24. Объект запроса
GeoSearchRequest extends RequestModel {
public $what;
public $is_cool_place;
public function rules() {
return array(
array('WhatValidator', 'min' => 2, 'max' => 50),
array('BooleanValidator',
'param' => 'is_cool_place',
'required' => false),
);
}
}

25. Валидатор объекта запроса
class WhatValidator extends Validator {
public function run(RequestModel $model) {
// ...
}
}

26. Объект запроса
Нет состояния
Декларативный подход
Наглядность

27. Структура директорий
/protected
/controllers
GeoController.php
/views
GeoView.php
/requests
/geo
GeoSearchRequest.php
/extensions
/geo
ExtGeo.php
/models
/components

28. Модель: Бизнес-логика и ActiveRecord
Представление
Контроллер
Объект запроса
Валидатор запроса
ВыводыКомпоненты архитектуры
Модель: Бизнес-логика и ActiveRecord
Представление
Контроллер
Объект запроса
Валидатор запроса

29. Автотесты

30. Гибридные тесты
Зависимости
Подмена данных

31. JSON Schema
Структура
Обязательность
Тип данных
XML Schema

32. PHP-реализация
Сам формат
http://json-schema.org/
PHP-библиотека от института Беркли
https://github.com/justinrainbow/json-schema

33. JSON
{ "a":10, "b":"boo" }

34. JSON Schema для него
{ "a":10, "b":"boo" }
{
"a": {
"type": "number",
"required": true
},
"b": {
"type": "string",
"required": true
}
}

35. Использование JSON Schema
Фильтр ответа
Тестируем в фоне
Включаем во время тестов
"additionalProperties": false

36. Приоритеты тестов
Публичный интерфейс
JSON Schema
Дешево
Часто используется
Бизнес-логика

37. Документация
— Ветка на фичу
— Вместе с кодом
— Актуальность
— Да ну её нафиг!

38. Тема: Бульдог + Носорог
"reviews_count": {
"type": "number",
"required": true,
"meta": {
"description": "Количество отзывов"
}
},

39. JSON Schema + документация
Дешевая документация
Автоматический рендеринг
Тесты на документацию

40. Итоги
Большой API
Архитектура
Автотесты
Документация

41. Спасибо. Вопросы?
s.korzhnev@2gis.ruСергей Коржнев