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

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

Avatar for Dmitry Efimov Dmitry Efimov
February 22, 2018
Programming
0
49

Инструменты для обнаружения рассинхронизации реализации “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
42
Автоматизация Document-Driven Development для проектов с большим API
Avatar for Dmitry Efimov tuwilof
0
45
Валидация “REST” API по документации APIB
Avatar for Dmitry Efimov tuwilof
0
42
Негативное тестирование “REST” API и защита от него
Avatar for Dmitry Efimov tuwilof
0
340
Ликбез по JSON
Avatar for Dmitry Efimov tuwilof
0
88
API Blueprint
Avatar for Dmitry Efimov tuwilof
0
81
Документирование API
Avatar for Dmitry Efimov tuwilof
0
190
Почему и как заменить все id на UUID
Avatar for Dmitry Efimov tuwilof
0
92
Authentication in rails. Monolith vs SPA
Avatar for Dmitry Efimov tuwilof
0
210

Other Decks in Programming

See All in Programming
JSONataを使ってみよう Step Functionsが楽しくなる実践テクニック #devio2025
Avatar for dafujii dafujii
1
530
AI Coding Agentのセキュリティリスク：PRの自己承認とメルカリの対策
Avatar for さうす s3h
0
200
How Android Uses Data Structures Behind The Scenes
Avatar for HyunWoo Lee l2hyunwoo
0
440
Android 16 × Jetpack Composeで縦書きテキストエディタを作ろう / Vertical Text Editor with Compose on Android 16
Avatar for cc4966 cc4966
1
200
Swift Updates - Learn Languages 2025
Avatar for Yuta Koshizawa koher
2
470
Kiroの仕様駆動開発から見えてきたAIコーディングとの正しい付き合い方
Avatar for clshinji clshinji
1
210
アセットのコンパイルについて
Avatar for ojun ojun9
0
120
rage against annotate_predecessor
Avatar for Junichi Kobayashi junk0612
0
170
時間軸から考えるTerraformを使う理由と留意点
Avatar for Ryoma Fujiwara fufuhu
16
4.8k
CloudflareのChat Agent Starter Kitで簡単！AIチャットボット構築
Avatar for syumai syumai
2
480
テストコードはもう書かない：JetBrains AI Assistantに委ねる非同期処理のテスト自動設計・生成
Avatar for makun makun
0
260
ぬるぬる動かせ！ Riveでアニメーション実装🐾
Avatar for Kuno Ayana kno3a87
1
210

Featured

See All Featured
The Myth of the Modular Monolith - Day 2 Keynote - Rails World 2024
Avatar for Eileen M. Uchitelle eileencodes
26
3k
Faster Mobile Websites
Avatar for Dean Hume deanohume
309
31k
The Web Performance Landscape in 2024 [PerfNow 2024]
Avatar for Tammy Everts tammyeverts
9
810
How to Ace a Technical Interview
Avatar for Jacob Kaplan-Moss jacobian
279
23k
Being A Developer After 40
Avatar for Adrian Kosmaczewski akosma
90
590k
StorybookのUI Testing Handbookを読んだ
Avatar for Shingo Yamazaki zakiyama
31
6.1k
Imperfection Machines: The Place of Print at Facebook
Avatar for Scott Boms scottboms
268
13k
Put a Button on it: Removing Barriers to Going Fast.
Avatar for kastner kastner
60
4k
The Success of Rails: Ensuring Growth for the Next 100 Years
Avatar for Eileen M. Uchitelle eileencodes
46
7.6k
The Illustrated Children's Guide to Kubernetes
Avatar for Chris Short chrisshort
48
50k
Code Review Best Practice
Avatar for Trisha Gee trishagee
70
19k
Reflections from 52 weeks, 52 projects
Avatar for Jefferson Lam jeffersonlam
352
21k

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