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