Lock in $30 Savings on PRO—Offer Ends Soon! ⏳

Let there be docs! A documentation-first approa...

Avatar for Svyatoslav Kryukov Svyatoslav Kryukov
September 27, 2023
Programming
0
1.7k

Let there be docs! A documentation-first approach to Rails API development

RESOURCES

Tools

Swagger Editor (beta)

Redocly VSCode Extension

Spectral && Spectral Rulesets

Real-World Spectral Rulesets

Prism

Swagger UI

Elements

Redoc

OpenAPI.Tools

Gems

committee

openapi_first

json_schemer

skooma

json_skooma

OpenAPI docs

Getting started

Specification

JSON Schema docs

JSON Schema in 5 minutes

Understanding JSON Schema

Reference documentation for JSON Schema

Talks

RailsConf 2018: Automating Empathy by Ariel Caplan

Contract First API Design with OpenAPI V3 by Darrel Miller

Introduction to OpenAPI by Lorna Jane Mitchell

Avatar for Svyatoslav Kryukov

Svyatoslav Kryukov

September 27, 2023
Tweet

More Decks by Svyatoslav Kryukov

See All by Svyatoslav Kryukov
Rails Frontend Evolution: It Was a Setup All Along
Avatar for Svyatoslav Kryukov skryukov
0
500
Defying Front-End Inertia: Inertia.js on Rails
Avatar for Svyatoslav Kryukov skryukov
0
1.4k
Assembling the Future: crafting the missing pieces of the Ruby on Wasm puzzle
Avatar for Svyatoslav Kryukov skryukov
0
560

Other Decks in Programming

See All in Programming
非同期処理の迷宮を抜ける: 初学者がつまづく構造的な原因
Avatar for PADAone pd1xx
1
690
これだけで丸わかり！LangChain v1.0 アップデートまとめ
Avatar for os1ma os1ma
6
1.7k
Go コードベースの構成と AI コンテキスト定義
Avatar for ANDPAD inc andpad
0
120
Context is King？ 〜Verifiability時代とコンテキスト設計 / Beyond "Context is King"
Avatar for r-kagaya rkaga
6
920
認証・認可の基本を学ぼう後編
Avatar for kaza kouyuume
0
180
[堅牢.py #1] テストを書かない研究者に送る、最初にテストを書く実験コード入門 / Let's start your ML project by writing tests
Avatar for Shunsuke KITADA shunk031
12
7.1k
バックエンドエンジニアによる Amebaブログ K8s 基盤への CronJobの導入・運用経験
Avatar for suna-big sunabig
0
140
251126 TestState APIってなんだっけ?Step Functionsテストどう変わる?
Avatar for Takumi Abe east_takumi
0
310
ZOZOにおけるAI活用の現在 ~モバイルアプリ開発でのAI活用状況と事例~
Avatar for ZOZO Developers zozotech
PRO
8
5.4k
手軽に積ん読を増やすには？/読みたい本と付き合うには？
Avatar for hideki kinjyo o0h
PRO
1
170
CSC509 Lecture 14
Avatar for Javier Gonzalez-Sanchez javiergs
PRO
0
220
Full-Cycle Reactivity in Angular: SignalStore mit Signal Forms und Resources
Avatar for Manfred Steyer manfredsteyer
PRO
0
200

Featured

See All Featured
Put a Button on it: Removing Barriers to Going Fast.
Avatar for kastner kastner
60
4.1k
It's Worth the Effort
Avatar for 3n 3n
187
29k
Keith and Marios Guide to Fast Websites
Avatar for Keith Pitt keithpitt
413
23k
10 Git Anti Patterns You Should be Aware of
Avatar for Lemi Orhan Ergin lemiorhan
PRO
659
61k
Side Projects
Avatar for Sacha Greif sachag
455
43k
Performance Is Good for Brains [We Love Speed 2024]
Avatar for Tammy Everts tammyeverts
12
1.3k
Designing Experiences People Love
Avatar for Jonathan Moore moore
143
24k
Fashionably flexible responsive web design (full day workshop)
Avatar for Andy Clarke malarkey
407
66k
Improving Core Web Vitals using Speculation Rules API
Avatar for Sergey Chernyshev sergeychernyshev
21
1.3k
YesSQL, Process and Tooling at Scale
Avatar for Rocio Delgado rocio
174
15k
ReactJS: Keep Simple. Everything can be a component!
Avatar for Pedro Nauck pedronauck
666
130k
[Rails World 2023 - Day 1 Closing Keynote] - The Magic of Rails
Avatar for Eileen M. Uchitelle eileencodes
37
2.6k

Transcript

  1. None
  2. None
  3. None
  4. None
  5. None
  6. None
  7. None
  8. None
  9. None
  10. None
  11. None
  12. None
  13. None
  14. None
  15. None
  16. None
  17. None
  18. None
  19. None
  20. None
  21. None
  22. None
  23. None
  24. None
  25. None
  26. None
  27. None
  28. None
  29. None
  30. None
  31. None
  32. None
  33. None
  34. None
  35. None
  36. None
  37. None
  38. None
  39. None
  40. None
  41. None
  42. None
  43. None
  44. None
  45. None
  46. None

  47. ❯ ✖

  48. ❯ ▶ ℹ ℹ ✔ ✔ ✔ ℹ ❯ ❯

  49. None
  50. None
  51. None
  52. None
  53. None
  54. None
  55. None
  56. None
  57. None
  58. None
  59. None
  60. None
  61. None
  62. None
  63. None
  64. None
  65. None
  66. None
  67. None
  68. None
  69. None
  70. None
  71. None
  72. None
  73. None
  74. None
  75. None