API Documentation Toolsets Could be Your Savior
feedproxy.google.com
on 02/22/2013
Excerpt: ProgrammableWeb now lists more than 8000+ APIs. The most successful APIs are even billionaires in their own right. We have covered several articles in the past on what are the essential components of a successful API and one pattern that comes out is the need for good developer documentation. In our first annual API survey, the results of which were released in early 2013 showed that the most important factor that developers look out for in an API is good documentation. Adam DuVander wrote an article “Six Ways to Accelerate Time to First Hello World” and having clear and accurate documentation is one of the ways. The task of writing clear documentation for your API is not trivial.... read the full post.
Tags: API-Evangelist, I/O Docs, Interactive Documentation, Swagger
Tools to generate beautiful API documentation
www.mattsilverman.com
on 02/16/2013
Excerpt: As demand for our Nutritionix API is starting to grow rapidly, we have been working on finding an API documentation engine to meet our needs for the long-term. I was not able to find any comprehensive list of existing API documentation solutions, so I am compiling what I have found so far. Please leave feedback on your own experience in the comments. We are still exploring each solution, but I will update this post as we learn more about each option. Swagger - A specification and complete framework implementation for describing, producing, consuming, and visualizing RESTful web services. [Demo] Note: We already use 3Scale. net for our API management solution, and they have an ActiveDocs feature based on Swagger.... read the full post.
Tags: API-Evangelist, API-Stack, Documentation, Interactive Documentation
Excerpt: As demand for our Nutritionix API is starting to grow rapidly, we have been working on finding an API documentation engine to meet our needs for the long-term. I was not able to find any comprehensive list of existing API documentation solutions, so I am compiling what I have found so far. Please leave feedback on your own experience in the comments. We are still exploring each solution, but I will update this post as we learn more about each option. Swagger - A specification and complete framework implementation for describing, producing, consuming, and visualizing RESTful web services. [Demo] Note: We already use 3Scale. net for our API management solution, and they have an ActiveDocs feature based on Swagger.... read the full post.
Tags: API-Evangelist, API-Stack, Documentation, Interactive Documentation
