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

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

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

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

Other Decks in Programming

See All in Programming
Team topologies and the microservice architecture: a synergistic relationship
Avatar for Chris Richardson cer
PRO
0
1.1k
Google Agent Development Kit でLINE Botを作ってみた
Avatar for Kento.Yamada ymd65536
2
210
Go1.25からのGOMAXPROCS
Avatar for kuro kuro_kurorrr
1
820
システム成長を止めない！本番無停止テーブル移行の全貌
Avatar for さかうぇ sakawe_ee
1
150
既存デザインを変更せずにタップ領域を広げる方法
Avatar for Tiphaine tahia910
1
240
生成AIコーディングとの向き合い方、AIと共創するという考え方 / How to deal with generative AI coding and the concept of co-creating with AI
Avatar for shiro seike seike460
PRO
1
340
#kanrk08 / 公開版 PicoRubyとマイコンでの自作トレーニング計測装置を用いたワークアウトの理想と現実
Avatar for bash0C7 bash0c7
1
630
5つのアンチパターンから学ぶLT設計
Avatar for Narihara narihara
1
130
地方に住むエンジニアの残酷な現実とキャリア論
Avatar for nakamichi ichimichi
5
1.4k
設計やレビューに悩んでいるPHPerに贈る、クリーンなオブジェクト設計の指針たち
Avatar for panda_program panda_program
6
1.7k
PipeCDのプラグイン化で目指すところ
Avatar for Warashi warashi
1
180
Modern Angular with Signals and Signal Store: New Rules for Your Architecture @enterJS Advanced Angular Day 2025
Avatar for Manfred Steyer manfredsteyer
PRO
0
150

Featured

See All Featured
Put a Button on it: Removing Barriers to Going Fast.
Avatar for kastner kastner
60
3.9k
Distributed Sagas: A Protocol for Coordinating Microservices
Avatar for Caitie McCaffrey caitiem20
331
22k
How STYLIGHT went responsive
Avatar for nonsquared nonsquared
100
5.6k
Practical Tips for Bootstrapping Information Extraction Pipelines
Avatar for Matthew Honnibal honnibal
PRO
20
1.3k
Making the Leap to Tech Lead
Avatar for Ryan Cromwell cromwellryan
134
9.4k
The Language of Interfaces
Avatar for Des Traynor destraynor
158
25k
RailsConf 2023
Avatar for Aaron Patterson tenderlove
30
1.1k
Build The Right Thing And Hit Your Dates
Avatar for Maggie C. maggiecrowley
36
2.8k
Facilitating Awesome Meetings
Avatar for Lara Hogan lara
54
6.4k
A Tale of Four Properties
Avatar for Chris Coyier chriscoyier
160
23k
Principles of Awesome APIs and How to Build Them.
Avatar for Keavy McMinn keavy
126
17k
The Psychology of Web Performance [Beyond Tellerrand 2023]
Avatar for Tammy Everts tammyeverts
48
2.9k

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