API Documentation 2.0 with Swagger and Stoplight at Namely

Katie Reed
Nov 7, 2016 · 5 min read

A quick Google search on how to best document your API will return a myriad of tools ranging from framework specification formats to software that will generate documentation with a slick and aesthetic UI. This article will break down our experience and experimentation with these tools, and what ultimately led to our optimal final product: API Documentation 2.0


Part I: The Philosophy

Part II: The Specification Framework

Part III: The API Documentation Generators

The original API documentation hosted with Readme.io
<<subdomain>>.namely.com
Namely’s API documentation hosted by Gelato
The new and improved Namely API Documentation hosted by Stoplight

Conclusion


Namely Labs

Namely Engineering + Design

Thanks to Sam Corcos and Bobby Tables

Katie Reed

Written by

Technologist

Namely Labs

Namely Engineering + Design

More From Medium

Welcome to a place where words matter. On Medium, smart voices and original ideas take center stage - with no ads in sight. Watch
Follow all the topics you care about, and we’ll deliver the best stories for you to your homepage and inbox. Explore
Get unlimited access to the best stories on Medium — and support writers while you’re at it. Just $5/month. Upgrade