Hacker News Reader

Comment by anonfunction | Hacker News Reader

I regularly use interactive API documentation to test APIs. It's just so much easier than using cURL or writing a script.

Most startups can't afford to spend the time and engineering resource reinventing the wheel for API documentation, especially with the "explorer" or interactive test consoles that have become so popular.

View on HN

As someone who wrote one recently, it's not so hard to build the interactive testing portion as the live editing functionality. I built an API documentation site over a week's period with interactive consoles and examples. (We use WADL as opposed to Swagger or others due to legacy reasons)

Live editing of API functionality? Much more complicated.

whats it called? is it public?

Check out Apigee SmartDocs: https://blog.apigee.com/detail/apigee_smartdocs_introducing_...

(top level readers: sorry about the double-post)

Why the apigee links? We want to see what this guy built over a week.

sad to see the spam indeed

I was assuming you or others wanted something you could actually use today.

Sorry, it's not public and I would probably get run out of town for basing it largely on jQuery and Handlebars. (It is fast though) It looks very similar to swagger.io except everything is expanded by default and I put a very basic js search capability that filters endpoints.

Cool, would love to see it if available publicly.

Check out Apigee SmartDocs: https://blog.apigee.com/detail/apigee_smartdocs_introducing_...

I agree that the editing functionality is more complicated but still contend that most startups would benefit from using an existing solution. Wether that's a service or an open-source project doesn't matter so much.

Here's an interactive API testing tool I made: https://github.com/Mashape/API-Test-Console

Reply on news.ycombinator.com