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.3k

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
210

Other Decks in Programming

See All in Programming
ECS Service Connectのこれまでのアップデートと今後のRoadmapを見てみる
tkikuc
2
250
『ドメイン駆動設計をはじめよう』のモデリングアプローチ
masuda220
PRO
8
540
2024/11/8 関西Kaggler会 2024 #3 / Kaggle Kernel で Gemma 2 × vLLM を動かす。
kohecchi
5
920
CSC509 Lecture 12
javiergs
PRO
0
160
Streams APIとTCPフロー制御 / Web Streams API and TCP flow control
tasshi
2
350
ActiveSupport::Notifications supporting instrumentation of Rails apps with OpenTelemetry
ymtdzzz
1
230
Outline View in SwiftUI
1024jp
1
330
Less waste, more joy, and a lot more green: How Quarkus makes Java better
hollycummins
0
100
NSOutlineView何もわからん:( 前編 / I Don't Understand About NSOutlineView :( Pt. 1
usagimaru
0
330
Jakarta EE meets AI
ivargrimstad
0
150
最新TCAキャッチアップ
0si43
0
140
Amazon Bedrock Agentsを用いてアプリ開発してみた！
har1101
0
330

Featured

See All Featured
The Invisible Side of Design
smashingmag
298
50k
Distributed Sagas: A Protocol for Coordinating Microservices
caitiem20
329
21k
Understanding Cognitive Biases in Performance Measurement
bluesmoon
26
1.4k
Reflections from 52 weeks, 52 projects
jeffersonlam
346
20k
The Cult of Friendly URLs
andyhume
78
6k
A better future with KSS
kneath
238
17k
GitHub's CSS Performance
jonrohan
1030
460k
Producing Creativity
orderedlist
PRO
341
39k
YesSQL, Process and Tooling at Scale
rocio
169
14k
The Illustrated Children's Guide to Kubernetes
chrisshort
48
48k
Site-Speed That Sticks
csswizardry
0
23
Art, The Web, and Tiny UX
lynnandtonic
297
20k

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