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

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

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
51
Автоматизация Document-Driven Development для проектов с большим API
Avatar for Dmitry Efimov tuwilof
0
52
Валидация “REST” API по документации APIB
Avatar for Dmitry Efimov tuwilof
0
48
Негативное тестирование “REST” API и защита от него
Avatar for Dmitry Efimov tuwilof
0
350
Ликбез по JSON
Avatar for Dmitry Efimov tuwilof
0
93
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
FastAPI の並行処理モデルを完全に理解する
Avatar for Yuki Ishikawa hoto17296
9
3.8k
Oxlintはいいぞ（続）
Avatar for Yuji Yamaguchi yug1224
1
560
What We Talk About When We Talk About XP
Avatar for seki at druby.org m_seki
2
420
AI時代に学ぶ 好きなルール 嫌いなルール Linter編
Avatar for Shota Nemoto shorty5121
0
890
[DroidKaigi 2026] Bring your own phones to Gradle Managed Devices
Avatar for Yury f2lk
0
110
From 6 People Classroom Meetup to 100 People Regional Conference / FOSS4G Hiroshima 2026
Avatar for YFurukawa furukawayasuto
0
120
思考垂れ流し開発　～音声入力 × AIエージェント × 開発ハーネスによる試行錯誤～
Avatar for NPOS npostring
0
980
Deep dive into the select statement (GopherCon UK)
Avatar for Jesús Espino jespino
0
170
DroidKaigi 2026 「個人開発という実験場: Android エンジニアが手にする4つの自由」
Avatar for SlashNephy slashnephy
0
220
個人開発基盤をまるごとCloudflareに引っ越して爆速で総合的体験を向上させた話
Avatar for Tsubasa SEKIGUCHI tinykitten
0
140
Swift愛好会と私（ウホーイ） / Swift Fan Club and Uhooi
Avatar for uhooi uhooi
0
150
Foundry Localでエージェント開発
Avatar for 瀬尾佳隆 seosoft
0
150

Featured

See All Featured
A better future with KSS
Avatar for Kyle Neath kneath
240
18k
YesSQL, Process and Tooling at Scale
Avatar for Rocio Delgado rocio
174
15k
So, you think you're a good person
Avatar for Per Axbom axbom
PRO
2
2.1k
More Than Pixels: Becoming A User Experience Designer
Avatar for Michelle Schulp Hunt marktimemedia
3
520
Java REST API Framework Comparison - PWX 2021
Avatar for Matt Raible mraible
34
9.7k
Navigating Weather and Climate Data
Avatar for Ryan Abernathey rabernat
0
510
Connecting the Dots Between Site Speed, User Experience & Your Business [WebExpo 2025]
Avatar for Tammy Everts tammyeverts
11
1k
RailsConf & Balkan Ruby 2019: The Past, Present, and Future of Rails at GitHub
Avatar for Eileen M. Uchitelle eileencodes
141
35k
Mozcon NYC 2025: Stop Losing SEO Traffic
Avatar for Sam Torres samtorres
1
520
The Mindset for Success: Future Career Progression
Avatar for Greg Gifford greggifford
PRO
0
490
WCS-LA-2024
Avatar for Leonardo Collado-Torres lcolladotor
0
820
The Limits of Empathy - UXLibs8
Avatar for Cassini Nazir cassininazir
1
640

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