Let there be docs! A documentation-first approach to Rails API development

Svyatoslav Kryukov

September 27, 2023

1k

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

Gems

OpenAPI docs

Getting started

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

Other Decks in Programming

See All in Programming

freeeのエンジニアが就活で出そうなコーディングテストを解説してみる

1

180

JavaScript Closure

0

2k

AppRouter Panel Talk

yosuke_furukawa

1

530

TypeScriptの型とパフォーマンス (TSKaigi 2024)

14

5.1k

PHPコードの実行モデルを理解する / Understanding-the-PHP-Execution-Model

0

1.1k

Namespace, What and Why

4

760

otelcol receiver 自作RTA / Pepabo Tech Conference #22 春のSREまつり

0

1.1k

Deep Dive into React Stream/Serialize

4

870

Open standards for building event-driven applications in the cloud

0

230

The Final Frontier of Web Development: React Server Components vs Jakarta EE

0

170

Jetpack Composeとデザインシステム

0

240

Enjoy Creative Coding with Ruby (RubyKaigi2024)

0

900

Featured

See All Featured

ピンチをチャンスに：未来をつくるプロダクトロードマップ #pmconf2020

84

45k

Building Adaptive Systems

32

1.9k

Designing for humans not robots

247

25k

Imperfection Machines: The Place of Print at Facebook

261

12k

Building Better People: How to give real-time feedback that sticks.

356

18k

A Philosophy of Restraint

197

16k

Rebuilding a faster, lazier Slack

74

8.3k

RailsConf & Balkan Ruby 2019: The Past, Present, and Future of Rails at GitHub

126

32k

Designing with Data

96

4.8k

jQuery: Nuts, Bolts and Bling

60

7.2k

[RailsConf 2023] Rails as a piece of cake

29

4.1k

Practical Orchestrator

183

9.8k

Transcript