Hacker News new | past | comments | ask | show | jobs | submit login

Congrats on the funding. However, I'm not sure what Apiary does, or why I'd use it. Could someone help me? Is it an API mocking tool? A documentation tool? Both? Can I use it next to my existing source tree?



Hi,

thanks!

Yes, it is both and yes, you can add it to your source tree through our github integration.

Our idea is to have a human-readable, human-writeable DSL to describe your API. From there, we generate both documentation, mocks, debugging proxy and tests.

You can use it to describe your existing APIs, but in my mind, our biggest value lies in conversation around API design that happens before you start implementing.

Hope this helps!


Hi, I'm not sure if I'm alone in this, but I personally hate to document my code outside my code. Is there any way to make apiary scan my existing codebase for, say. API documentation and generate docs based on that?


Hi, there are some 3rd party works in progress and we will promote them. We are leaving this to community though, as respective languages/frameworks are best supported by people that use them.

And as said -- Apiary is more about design than documentation and writing blueprint should take place before writing code. A lot of things is lost when it's the other way around.




Join us for AI Startup School this June 16-17 in San Francisco!

Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: