Welcome to the beta for Optic's latest feature: auto-docs!
How can auto-docs help me?
📝 Documentation by Default. Accurate docs for any API
😄 Happy Developers! Give people the resources they need to work faster
🎨 A beautiful API Design tool with built-in docs
📊 See how APIs are used. Understand how changes will affect consumers
<aside> 💡 Coming soon 📝 Enforce API Standards, 📲 Generate SDK Clients, 🔦 Automated Tests
</aside>
https://adc2019.typeform.com/to/VkkB1o
When developing your API locally, start your API with Optic's api start
command instead of npm start
or whatever other command you use today.
That's all you have to do to get docs! As you develop with Optic, it documents your entire API by observing its behavior in real time. Here's an example of GitHub's docs inside of Optic.