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

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

Sponsored · Ship Features Fearlessly Turn features on and off without deploys. Used by thousands of Ruby developers. →
Avatar for Svyatoslav Kryukov Svyatoslav Kryukov
September 27, 2023
Programming
1.8k
0

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

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
670
Defying Front-End Inertia: Inertia.js on Rails
Avatar for Svyatoslav Kryukov skryukov
0
1.6k
Assembling the Future: crafting the missing pieces of the Ruby on Wasm puzzle
Avatar for Svyatoslav Kryukov skryukov
0
670

Other Decks in Programming

See All in Programming
AI時代のPhpStorm最新事情 #phpcon_odawara
Avatar for yusuke yusuke
0
170
瑠璃の宝石に学ぶ技術の声の聴き方 / 【劇場版】アニメから得た学びを発表会2026 #エンジニアニメ
Avatar for mazrean mazrean
0
240
おれのAgentic Coding 2026/03
Avatar for TsukasaSekiguchi tsukasagr
1
140
レガシーPHP転生 〜父がドメインエキスパートだったのでDDD+Claude Codeでチート開発します〜
Avatar for panda_program panda_program
0
880
Reactive ❤️ Loom: A Forbidden Love Story
Avatar for Francesco Nigro franz1981
2
230
飯MCP
Avatar for Yusuke Wada yusukebe
0
510
Codex CLI でつくる、Issue から merge までの開発フロー
Avatar for amata1219 amata1219
0
350
「効かない！」依存性注入（DI）を活用したAPI Platformのエラーハンドリング奮闘記
Avatar for Maki Hayashi mkmk884
1
330
Server-Side Kotlin LT大会 vol.18 [Kotlin-lspの最新情報と Neovimのlsp設定例]
Avatar for yasunori yasunori0418
1
130
ハーネスエンジニアリングにどう向き合うか 〜ルールファイルを超えて開発プロセスを設計する〜 / How to approach harness engineering
Avatar for r-kagaya rkaga
20
10k
「Linuxサーバー構築標準教科書」を読んでみた #ツナギメオフライン.7
Avatar for akase244 akase244
0
1.4k
PDI: Como Alavancar Sua Carreira e Seu Negócio
Avatar for Marcel dos Santos marcelgsantos
0
120

Featured

See All Featured
Designing for Timeless Needs
Avatar for Cassini Nazir cassininazir
0
190
Digital Ethics as a Driver of Design Innovation
Avatar for Per Axbom axbom
PRO
1
260
Have SEOs Ruined the Internet? - User Awareness of SEO in 2025
Avatar for Akash Hashmi akashhashmi
0
310
The #1 spot is gone: here's how to win anyway
Avatar for Tamara Novitovic tamaranovitovic
2
1k
AI in Enterprises - Java and Open Source to the Rescue
Avatar for ivargrimstad ivargrimstad
0
1.2k
For a Future-Friendly Web
Avatar for Brad Frost brad_frost
183
10k
Building Better People: How to give real-time feedback that sticks.
Avatar for Will Jessup wjessup
370
20k
DevOps and Value Stream Thinking: Enabling flow, efficiency and business value
Avatar for Helen Beal helenjbeal
1
160
Let's Do A Bunch of Simple Stuff to Make Websites Faster
Avatar for Chris Coyier chriscoyier
508
140k
Sharpening the Axe: The Primacy of Toolmaking
Avatar for Bryan Cantrill bcantrill
46
2.8k
The Mindset for Success: Future Career Progression
Avatar for Greg Gifford greggifford
PRO
0
310
Bash Introduction
Avatar for André Augusto Costa Santos 62gerente
615
210k

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