Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Инструменты для обнаружения рассинхронизации ре...

Sponsored · Your Podcast. Everywhere. Effortlessly. Share. Educate. Inspire. Entertain. You do you. We'll handle the rest. →
Avatar for Dmitry Efimov Dmitry Efimov
February 22, 2018
Programming
0
53

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

Avatar for Dmitry Efimov

Dmitry Efimov

February 22, 2018
Tweet

More Decks by Dmitry Efimov

See All by Dmitry Efimov
Автоматизируем синхронизацию HTTP API и документации
Avatar for Dmitry Efimov tuwilof
0
46
Автоматизация Document-Driven Development для проектов с большим API
Avatar for Dmitry Efimov tuwilof
0
48
Валидация “REST” API по документации APIB
Avatar for Dmitry Efimov tuwilof
0
45
Негативное тестирование “REST” API и защита от него
Avatar for Dmitry Efimov tuwilof
0
340
Ликбез по JSON
Avatar for Dmitry Efimov tuwilof
0
91
API Blueprint
Avatar for Dmitry Efimov tuwilof
0
85
Документирование API
Avatar for Dmitry Efimov tuwilof
0
200
Почему и как заменить все id на UUID
Avatar for Dmitry Efimov tuwilof
0
100
Authentication in rails. Monolith vs SPA
Avatar for Dmitry Efimov tuwilof
0
210

Other Decks in Programming

See All in Programming
文字コードの話
Avatar for Masaki Hara qnighy
44
17k
受け入れテスト駆動開発(ATDD)×AI駆動開発 AI時代のATDDの取り組み方を考える
Avatar for Takasaki Kazunari kztakasaki
2
570
クライアントワークでSREをするということ。あるいは事業会社におけるSREと同じこと・違うこと
Avatar for nnaka2992 nnaka2992
1
340
SourceGeneratorのマーカー属性問題について
Avatar for tkym htkym
0
190
API Platformを活用したPHPによる本格的なWeb API開発 / api-platform-book-intro
Avatar for Takashi Kanemoto ttskch
1
130
ベクトル検索のフィルタを用いた機械学習モデルとの統合 / python-meetup-fukuoka-06-vector-attr
Avatar for monochromegane monochromegane
2
410
OTP を自動で入力する裏技
Avatar for Megabits_mzq megabitsenmzq
0
100
AI Assistants for Your Angular Solutions
Avatar for Manfred Steyer manfredsteyer
PRO
0
140
DevinとClaude Code、SREの現場で使い倒してみた件
Avatar for karia/Y.Hisamatsu karia
1
1k
メタプログラミングで実現する「コードを仕様にする」仕組み/nikkei-tech-talk43
Avatar for 日本経済新聞社 エンジニア採用事務局 nikkei_engineer_recruiting
0
180
CSC307 Lecture 15
Avatar for Javier Gonzalez-Sanchez javiergs
PRO
0
240
LangChain4jとは一味違うLangChain4j-CDI
Avatar for Kenji Kazumura kazumura
1
180

Featured

See All Featured
10 Git Anti Patterns You Should be Aware of
Avatar for Lemi Orhan Ergin lemiorhan
PRO
659
61k
XXLCSS - How to scale CSS and keep your sanity
Avatar for Zaharenia Atzitzikaki sugarenia
249
1.3M
Into the Great Unknown - MozCon
Avatar for Noah Learner thekraken
40
2.3k
How to Create Impact in a Changing Tech Landscape [PerfNow 2023]
Avatar for Tammy Everts tammyeverts
55
3.3k
Chrome DevTools: State of the Union 2024 - Debugging React & Beyond
Avatar for Addy Osmani addyosmani
10
1.1k
The Director’s Chair: Orchestrating AI for Truly Effective Learning
Avatar for Mike Taylor tmiket
1
130
The Power of CSS Pseudo Elements
Avatar for Geoffrey Crofte geoffreycrofte
82
6.2k
Save Time (by Creating Custom Rails Generators)
Avatar for Garrett Dimon garrettdimon
PRO
32
2.4k
SEOcharity - Dark patterns in SEO and UX: How to avoid them and build a more ethical web
Avatar for Sara Fernández Carmona sarafernandez
0
150
Rails Girls Zürich Keynote
Avatar for Gregor Martynus gr2m
96
14k
Why You Should Never Use an ORM
Avatar for John Nunemaker jnunemaker
PRO
61
9.8k
I Don’t Have Time: Getting Over the Fear to Launch Your Podcast
Avatar for Joe Casabona jcasabona
34
2.7k

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 =

    ?
  20. None

  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-ам

  26. None

  27. gem ‘fdoc’

  28. +не нужно явно писать роутинг к json-schema-ам

  29. - только свой синтаксис на документацию и тесты

  30. None

  31. gem ‘fitting’

  32. +не нужно явно писать роутинг к json-schema-ам

  33. + работает с обычными rspec тестами и использует существующую документацию

    на API Blueprint (и в теории Swagger)

  34. + без фатального недостатка

  35. None

  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?
  49. None