News for hackers. Stuff that matters.

apidoc

Re:Germany turns up pressure in suspected US spy case on Monday July 07, 2014 @10:26AM (#7998971)
If it not "hurt" anybody, where is than the problem that they spy the US-Citizens too?
It depend on what you want.

HN/TC/... are good to show a new product to people that want to see new products. Thats it.

That did not mean that you get customers or a wider audience.

One year ago i launch http://apidocjs.com (OpenSource for RESTful API documentation), i show it to HN and got 2.500 Visitors in one day (yeah!), but the next days nearly zero.

Further development and step by step more users find their way to apiDoc -> organic growth.

Re:The API-ization of everything on Thursday November 07, 2013 @04:31AM (#6688490)
API's are great, but they are not the end of development.

While i develop several projects and write OpenSource apiDoc (http://apidocjs.com) i see the advantages of API's like you did it. Clean way of development and access, but on the other side some double work on frontend and backend (for own Applications).

Iam excited of the next evolution step of API's or what will be used after API's.

Re:The Coming Dropbox Apocalypse on Thursday September 19, 2013 @10:19AM (#6411770)
Yes thats not much. Node modules use other modules, that mean you have many many files.

For my small apidoc-Tool (apidocjs.com) i have over 2.000 Files, the project itself has only 50 Files ;-)

Another node project (only a small API-Server) has 20.000 files.

Re:Beg HN: Please only report serious GitHub outages (1h+) on Tuesday August 06, 2013 @06:41AM (#6165788)
I dont know why so many people always post it. Please use Twitter for that.

Or just look at

https://status.github.com/

Re:Ractive.js on Thursday July 25, 2013 @05:51AM (#6101657)
Nice little library. I think i will have a close look and implement it into apiDoc (http://apidocjs.com) Templates - for now i use crude jQuery events (quick & dirty coded). With Ractive i think i can make the code cleaner and easier to modify.

At the moment i prefer Backbone in my other projects, but it is to "heavy" for a small single page (especially for users that did not know backbone and want to modify the templates).

And it use apidoc for backend documentation ;-)
Re:Designing a Pragmatic RESTful API on Tuesday June 04, 2013 @11:57AM (#5820210)
All blogs and howtos only describe the change of API Access with new versions, but not how to handle different backend data versions.

One way is to use the newest version in Client and the Server has to convert old Data to new Data, then deliver to Client. But sometimes it not so easy, depend on complexity of your data.

Other way: convert all Data to new Version and change Data-Access in the old Api Version (but here is the Problem with: never change a running system, things that work before could go wrong). And if you have a huge site with many users, it is not possibly to interrupt the service.

To maintain many versions is for a short period ok, but for longer usage not practicable.

Did somebody have experience with that ?

Re:Manchester City Council on Thursday May 02, 2013 @08:15AM (#5643927)
Design is nice, but "baaaam" too much for what the page is and for who the page is. Why i have to click to open the services? Better show them directly.
Re:ApiDoc - Inline Documentation for RESTful web APIs on Sunday April 21, 2013 @08:28AM (#5584643)
Hope some people write here some alternatives, i always watch for good tools too. Most of the documentation tools document the code itself (like JSDoc), but i did not found many for RESTful Api documentation, thats why i start the project :)
Re:ApiDoc - Inline Documentation for RESTful web APIs on Sunday April 21, 2013 @08:09AM (#5584608)
You can use it on any source, but we write it in JavaScript with NodeJs.