Upgrade to PRO for Only $50/Year—Limited-Time Offer! 🔥

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
510
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
なあ兄弟、 余白の意味を考えてから UI実装してくれ！
Avatar for Ryomm ktcryomm
11
11k
Integrating WordPress and Symfony
Avatar for Alexandre Salomé alexandresalome
0
150
從冷知識到漏洞，你不懂的 Web，駭客懂 - Huli @ WebConf Taiwan 2025
Avatar for Huli aszx87410
1
970
生成AIを利用するだけでなく、投資できる組織へ
Avatar for pospome pospome
0
240
AIエンジニアリングのご紹介 / Introduction to AI Engineering
Avatar for r-kagaya rkaga
5
2k
ViewファーストなRailsアプリ開発のたのしさ
Avatar for sugiwe sugiwe
0
430
これだけで丸わかり！LangChain v1.0 アップデートまとめ
Avatar for os1ma os1ma
6
1.7k
開発に寄りそう自動テストの実現
Avatar for Hiroki Iseri goyoki
1
760
Building AI Agents with TypeScript #TSKaigiHokuriku
Avatar for izumin5210 izumin5210
6
1.3k
テストやOSS開発に役立つSetup PHP Action
Avatar for Atsushi Matsuo matsuo_atsushi
0
150
【Streamlit x Snowflake】データ基盤からアプリ開発・AI活用まで、すべてをSnowflake内で実現
Avatar for Ayumu Yamaguchi ayumu_yamaguchi
1
120
20 years of Symfony, what's next?

Avatar for Fabien Potencier fabpot
2
350

Featured

See All Featured
Docker and Python
Avatar for Tania Allard trallard
47
3.7k
Designing for humans not robots
Avatar for Tammie Lister tammielis
254
26k
Imperfection Machines: The Place of Print at Facebook
Avatar for Scott Boms scottboms
269
13k
Mobile First: as difficult as doing things right
Avatar for Swwweet swwweet
225
10k
Navigating Team Friction
Avatar for Lara Hogan lara
191
16k
The Web Performance Landscape in 2024 [PerfNow 2024]
Avatar for Tammy Everts tammyeverts
12
970
Context Engineering - Making Every Token Count
Avatar for Addy Osmani addyosmani
9
490
Balancing Empowerment & Direction
Avatar for Lara Hogan lara
5
790
[RailsConf 2023 Opening Keynote] The Magic of Rails
Avatar for Eileen M. Uchitelle eileencodes
31
9.8k
CoffeeScript is Beautiful & I Never Want to Write Plain JavaScript Again
Avatar for Sam Stephenson sstephenson
162
15k
CSS Pre-Processors: Stylus, Less & Sass
Avatar for Bermon Painter bermonpainter
359
30k
KATA
Avatar for Megan Lloyd mclloyd
PRO
32
15k

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