Upgrade to Pro — share decks privately, control downloads, hide ads and more …
Sign up for free

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

Sponsored · Ship Features Fearlessly Turn features on and off without deploys. Used by thousands of Ruby developers. →
Avatar for Dmitry Efimov Dmitry Efimov
February 22, 2018
Programming
58
0

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

Avatar for Dmitry Efimov

Dmitry Efimov

February 22, 2018

More Decks by Dmitry Efimov

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

Other Decks in Programming

See All in Programming
Augmenting AI with the Power of Jakarta EE
Avatar for ivargrimstad ivargrimstad
0
230
golang-bob.pdf
Avatar for Yura Iwatsuka iwatsukayura
0
130
IBM Bob でAI駆動開発『QC-Playbook』
Avatar for 1kano ichirokano2
0
110
半永久的に提供し続けられるプライベートクラウドを目指して ― 利用者の認知負荷を抑えるAPI抽象化とハードウェア世代交代の基盤設計
Avatar for Tomofumi Kondo tomokon
0
500
パズルゲームの作り方 / how to make puzzle games
Avatar for kaityo256 kaityo256
PRO
2
300
パスワード再設定メールのURLについて知っておこう
Avatar for uyuki uyuki234
0
160
HTML-in-Canvasで作る未来のWeb UI表現
Avatar for IKEDA Yasunobu clockmaker
5
5.2k
IBM Bob Dojo #1 仕様駆動開発入門
Avatar for Akira Onishi (IBM) oniak3ibm
PRO
0
400
Kotlinの15年とServer-Side Kotlin
Avatar for Takehata Naoto n_takehata
1
150
When benchmarks go bad - what I learned from measuring performance wrong
Avatar for Holly Cummins hollycummins
0
220
Findy - エンジニア向け会社紹介/Findy Company Deck
Avatar for Findy findyinc
6
400k
KiroのSpecで「五目並べ」を作ってみる
Avatar for Satoshi Kaneyasu satoshi256kbyte
1
380

Featured

See All Featured
Why Our Code Smells
Avatar for Brandon Keepers bkeepers
PRO
340
58k
B2B Lead Gen: Tactics, Traps & Triumph
Avatar for Sophie Logan marketingsoph
1
280
Making Projects Easy
Avatar for Brett Harned brettharned
120
6.8k
Mind Mapping
Avatar for Hélio Medeiros helmedeiros
1
400
"I'm Feeling Lucky" - Building Great Search Experiences for Today's Users (#IAC19)
Avatar for Dan Newman danielanewman
230
23k
Data-driven link building: lessons from a $708K investment (BrightonSEO talk)
Avatar for Szymon Słowik szymonslowik
1
1.4k
Fireside Chat
Avatar for paigeccino paigeccino
43
4.1k
Jamie Indigo - Trashchat’s Guide to Black Boxes: Technical SEO Tactics for LLMs
Avatar for Tech SEO Connect techseoconnect
PRO
0
710
How Software Deployment tools have changed in the past 20 years
Avatar for Geshan Manandhar geshan
2
35k
Redefining SEO in the New Era of Traffic Generation
Avatar for Szymon Słowik szymonslowik
1
480
HTML-Aware ERB: The Path to Reactive Rendering @ RubyCon 2026, Rimini, Italy
Avatar for Marco Roth marcoroth
5
830
The browser strikes back
Avatar for Jono Alderson jonoalderson
0
1.8k

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