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

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

Svyatoslav Kryukov
September 27, 2023
Programming
0
1.2k

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

Svyatoslav Kryukov

September 27, 2023
Tweet

More Decks by Svyatoslav Kryukov

See All by Svyatoslav Kryukov
Assembling the Future: crafting the missing pieces of the Ruby on Wasm puzzle
skryukov
0
120

Other Decks in Programming

See All in Programming
全方位強化 Python 服務可觀測性：以 FastAPI 和 Grafana Stack 為例
blueswen
1
360
Iteratorでページネーションを実現する
sonatard
3
700
The Myth of the Modular Monolith - Day 2 Keynote - Rails World 2024
eileencodes
5
210
利用者視点で考える、イテレータとの上手な付き合い方
syumai
4
210
実践Dash - 手を抜きながら本気で作るデータApplicationの基本と応用 / Dash for Python and Baseball
shinyorke
2
210
Taking LLMs out of the black box: A practical guide to human-in-the-loop distillation
inesmontani
PRO
3
1.1k
"noncopyable types" の使いどころについて考えてみた
andpad
0
130
標準ライブラリの動向とイテレータのパフォーマンス
makki_d
3
180
Composing an API the *right* way (Droidcon New York 2024)
zsmb
2
540
ROS 2のZenoh対応とZenohのROS 2対応
takasehideki
2
240
Quarto Clean Theme
nicetak
0
220
API Platform for Laravel
dunglas
1
1.2k

Featured

See All Featured
Java REST API Framework Comparison - PWX 2021
mraible
PRO
28
7.5k
Six Lessons from altMBA
skipperchong
26
3.4k
No one is an island. Learnings from fostering a developers community.
thoeni
19
2.9k
A better future with KSS
kneath
235
17k
Fontdeck: Realign not Redesign
paulrobertlloyd
81
5.2k
Learning to Love Humans: Emotional Interface Design
aarron
271
40k
Performance Is Good for Brains [We Love Speed 2024]
tammyeverts
1
230
Speed Design
sergeychernyshev
22
460
Creatively Recalculating Your Daily Design Routine
revolveconf
217
12k
The Power of CSS Pseudo Elements
geoffreycrofte
71
5.3k
The Art of Programming - Codeland 2020
erikaheidi
50
13k
Git: the NoSQL Database
bkeepers
PRO
425
64k

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