Инструменты для обнаружения рассинхронизации реализации “REST” API от документации

Transcript

1. Инструменты для обнаружения рассинхронизации реализации “REST” API от документации
2. что такое реализованный код? как получить по нему информацию?
3. его тестируют, значит он существует
4. пусть реализация = тесты
5. тесты
6. нам нужно TDD
7. Test-Driven Development
8. документация
9. она тоже нужна
10. документация
11. какая документация без DDD
12. DDD?
13. Domain-Driven Design?
14. Проблемно- ориентированное проектированиe?
15. NO
16. Documentation- Driven Development
17. DDD это как TDD
 только вместо тестов документация
18. и те же проблемы, снова нужно что то писать помимо кода и поддерживать
19. а что будет если их соединить
 DDD + TDD = ?
21. DDDTDD?
22. Document / Test-Driven Development (DTDD) Joshua Richardson https://techblog.chegg.com/2014/12/16/document- test-driven-development-dtdd/
23. идея не нова
24. gem 'apivore'
25. - нужно явно писать роутинг к json-schema-ам
27. gem ‘fdoc’
28. +не нужно явно писать роутинг к json-schema-ам
29. - только свой синтаксис на документацию и тесты
31. gem ‘fitting’
32. +не нужно явно писать роутинг к json-schema-ам
33. + работает с обычными rspec тестами и использует существующую документацию на API Blueprint (и в теории Swagger)
34. + без фатального недостатка
36. что имеем?
37. тесты документация
38. fitting может проверить объединение между этими двумя множествами
39. JOIN! (прямо как БД)
40. тесты документация идеально не реализованно не задокументированно
41. всего два отчета реализованно / не реализованно задокументированно / не задокументированно
42. для сервера достаточно проверять что он возвращает ответы по документации
43. но ответ не получить без запроса
44. 1. смотрим задокументирован ли роут за запрос
45. 2. смотрим есть ли в документации ответ с таким статусом
46. 3. матчи ответ по JSON Schema из доки
47. 4. (в ближайшем будущем) смотрим “покрытие” JSON Schema
48. где примеры? и можно ли добавить в fitting адаптер, что бы переиспользовать в других языках и технологиях, например в проектах на Erlang?