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

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

Sponsored · Your Podcast. Everywhere. Effortlessly. Share. Educate. Inspire. Entertain. You do you. We'll handle the rest. →
Avatar for Svyatoslav Kryukov Svyatoslav Kryukov
September 27, 2023
Programming
1.9k
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
730
Defying Front-End Inertia: Inertia.js on Rails
Avatar for Svyatoslav Kryukov skryukov
0
1.7k
Assembling the Future: crafting the missing pieces of the Ruby on Wasm puzzle
Avatar for Svyatoslav Kryukov skryukov
0
720

Other Decks in Programming

See All in Programming
CSC307 Lecture 17
Avatar for Javier Gonzalez-Sanchez javiergs
PRO
0
310
フロントエンドとバックエンドで「1文字」を揃えよう
Avatar for てきめん tekimen youkidearitai
PRO
0
180
AIとASP.NET Coreで雑Webアプリを作った話
Avatar for Mayuki Sawatari mayuki
0
250
TSKaigi 2026 TypeScriptバックエンドのオブザーバビリティ戦略 — Datadog × NestJSの実践
Avatar for Taisei Yamamoto taiseiyamamotoan
2
270
権限チェックの一貫性を型で守る TypeScript による多層防御
Avatar for aster-mnch (kitagawa) mnch
4
1.1k
TypeSpec で繋ぐ複数プロダクトの型安全
Avatar for Mitsui maroon8021
1
360
Technical Debt: Understanding it Rightly, Engaging it Rightly #LaravelLiveJP
Avatar for shogogg shogogg
0
190
3Dシーンの圧縮
Avatar for Fadis fadis
1
590
The NotImplementedError Problem in Ruby
Avatar for Koichi ITO koic
1
500
密結合なバックエンドから TypeScript のコードを生成する
Avatar for kemuridama kemuridama
1
700
キャリア迷子上等 ─ "ない道"は自分で作ればいい
Avatar for 16bit_idol 16bitidol
2
240
GitHub Copilot CLIのいいところ
Avatar for tkym htkym
2
1.3k

Featured

See All Featured
Exploring anti-patterns in Rails
Avatar for Elle Meredith aemeredith
3
390
How to Grow Your eCommerce with AI & Automation
Avatar for Katarina Dahlin katarinadahlin
PRO
1
200
Joys of Absence: A Defence of Solitary Play
Avatar for Sebastian Deterding codingconduct
1
380
The SEO Collaboration Effect
Avatar for Kristina Bergwall kristinabergwall1
1
470
Fashionably flexible responsive web design (full day workshop)
Avatar for Andy Clarke malarkey
408
66k
How To Speak Unicorn (iThemes Webinar)
Avatar for Michelle Schulp Hunt marktimemedia
1
480
30 Presentation Tips
Avatar for Ian Lurie portentint
PRO
1
310
Unlocking the hidden potential of vector embeddings in international SEO
Avatar for Frank van Dijk frankvandijk
0
830
How to audit for AI Accessibility on your Front & Back End
Avatar for davetheseo davetheseo
0
400
What Being in a Rock Band Can Teach Us About Real World SEO
Avatar for Ade Holder 427marketing
0
240
My Coaching Mixtape
Avatar for mlcsv mlcsv
0
140
The AI Revolution Will Not Be Monopolized: How open-source beats economies of scale, even for LLMs
Avatar for Ines Montani inesmontani
PRO
3
3.5k

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