OpenAPI / JSON learning resource

Hello!

Last month I did research from the community about existing use of learning resources for both OpenAPI & JSON schema specifications. We had a hunch there could be an improvement, in a unified and interlinked experience for junior - senior devs to both learn and revise.

Check it out here: appear.sh/api-toolkit/specs

I published it last night and hope to gather feedback and issue reports from anyone interested.

Features:

  • OAS + JSON are interlinked within the page for most URLs, meaning less off-site links and switching tabs
  • Hidden boilerplate to reduce clutter
  • Added code examples in specs section to add context
  • Supports all OAS versions and JSON docs, inc. OAS 3.2
  • Added resource pages for further reading (FAQs, Glossary, Misunderstood keywords) for newcomers to OAS/JSON
  • AI chat using specs and diffs for deterministic responses with reference anchor links for further reading
  • Highlightable text to add your own notes, stored locally
  • OpenAPI tools list: searchable, filterable, showing popularity and maintenance of repo

I hope it provides a smoother learning experience!

Cheers,

Tom

OpenAPI / JSON learning resource

3 comments · 88% upvoted · other discussions

comments

Frequent_Dig8251

Awesome! love the examples. I wonder if you can switch to 3 column layout where 3rd column is showing examples all the time.

TomMkV [OP]

Thanks! I’ll look at making three columns and see how it works. My concern is the spec tables don’t have enough space and it becomes too narrow, but I’ll see.