Разработка развесистого API на Yii фреймворке. Коржнев
3 likes2,353 views
Документ описывает разработку справочного API на фреймворке Yii, подчеркивая его сложность и многообразие методов. В нем обсуждаются архитектурные аспекты, включая слоистую архитектуру, обработку запросов и тестирование. Также затрагиваются проблемы документации и стандартизации форматов ответа API.
![Конфигурация
return [
'components' => [
'geoCoder' => [
'class' => 'ext.geoCoder.ExtGeoCoder',
'country' => 'Russia'
],
//...
],
];](https://image.slidesharecdn.com/preza-devconf-end-130616233853-phpapp02/85/API-Yii-18-320.jpg)
![Объект запроса
class GeoSearchRequest extends RequestModel {
public $what;
public function rules() {
return [
['WhatValidator',
'min' => 2,
'max' => 50,
'required' => true
]
];
}
}](https://image.slidesharecdn.com/preza-devconf-end-130616233853-phpapp02/85/API-Yii-30-320.jpg)
Разработка развесистого API на Yii фреймворке. Коржнев
- 1. Разработка развесистого API на Yii фреймворке Сергей Коржнев
- 2. Крайний за архитектуру справочного API 2ГИС
- 6. API 2ГИС в цифрах уников в месяц online более 500 проектов >10 000 000
- 7. Большой API Сложное внутреннее устройство Более 50методов
- 9. Маленькое API — Просто — Быстро — Стандартный подход
- 11. По мере роста Разработка Баги
- 12. По мере роста Разработка СложностьБаги
- 13. Решение
- 14. Слоистая архитектура Application Layer Physical Layer Data Link Layer Network Layer Transport Layer Session Layer Presentation Layer Application Layer
- 18. Конфигурация return [ 'components' => [ 'geoCoder' => [ 'class' => 'ext.geoCoder.ExtGeoCoder', 'country' => 'Russia' ], //... ], ];
- 19. ActiveRecord
- 21. Плохо Классический рендеринг в файлах
- 22. Плохо $this->render('file3', $data); $this->render('file2', $data); $this->render('file1', $data); file2 file1 Контроллер
- 26. Валидация и фильтрация /geo/search?what=кафе'; DROP TABLE users; SELECT * FROM users WHERE 'x' = 'x
- 27. Фильтры контроллера Лучше, чем ничего Но можно лучше
- 29. Инкапсуляция запроса class GeoSearchRequest extends RequestModel { public $what; }
- 30. Объект запроса class GeoSearchRequest extends RequestModel { public $what; public function rules() { return [ ['WhatValidator', 'min' => 2, 'max' => 50, 'required' => true ] ]; } }
- 31. Валидатор class WhatValidator extends Validator { public function run(RequestModel $model) { // ... } }
- 34. Модель: Бизнес-логика и ActiveRecord Представление Контроллер Объект запроса Валидатор запроса ВыводыКомпоненты архитектуры Модель: Бизнес-логика и ActiveRecord Контроллер Представление Объект запроса Валидатор запроса
- 35. Автотесты
- 37. Гибридные тесты
- 41. Все уже придумано до нас XML Schema JSON Schema
- 42. JSON Schema & PHP Формат http://json-schema.org/ Библиотека от института Беркли https://github.com/justinrainbow/json-schema
- 43. JSON { "a":10, "b":"boo" }
- 44. JSON Schema { "a":10, "b":"boo" } { "a": { "type": "number", "required": true }, "b": { "type": "string", "required": true } }
- 45. Использование JSON Schema Включаем только в тестах В фоне
- 47. Ещё дёгтя Формат не устаканился Библиотеки сырые
- 49. Приоритеты тестов Публичный интерфейс JSON Schema Дешево Часто используется Бизнес-логика
- 50. Документация
- 51. Документация — Ветка на фичу
- 52. Документация — Ветка на фичу — Актуальность
- 53. Документация — Ветка на фичу — Актуальность — Вместе с кодом
- 54. Документация — Да ну её нафиг!
- 55. Бульдог + Носорог "reviews_count": { "type": "number", "required": true, "meta": { "description": "Количество отзывов" } },
- 56. JSON Schema + документация Дешево Рендеринг Тесты
- 57. Итоги Специфика большого API Слоистая архитектура Автотесты Документация + JSON Schema