PW Forum / Documenting an API

You are not logged in.


#1 2007-09-06 11:57:29

amikael
New member
Registered: 2007-09-06
Posts: 6

Documenting an API

Hi, I'm facing the task to put the whole API for http://www.widgetplus.com online and I'm a bit at loss on how to do that exactly.

What is the best online documentation you've seen?
(Thinking I could copy - or at least learn - from that)

I've started in a small way over at http://www.widgetplus.com/testbed.htm but I'm quite aware it needs much improvement, and fast.

Offline

 

#2 2007-09-06 21:54:37

jmusser
Administrator
Registered: 2006-04-28
Posts: 115
Website

Re: Documenting an API

Hi amikael,

That's a good question. There's so much variety (and certainly more that's so-so than great). Check-out the Flickr docs.

Also, try Digg
http://apidoc.digg.com/

Or, Freshbooks
http://developers.freshbooks.com/

If you want others let me know and I can get you more ideas.

John

Offline

 

Board footer

Powered by PunBB
© Copyright 2002–2005 Rickard Andersson

Follow the PW team on Twitter

ProgrammableWeb
APIs, mashups and code. Because the world's your programmable oyster.

John Musser
Founder, ProgrammableWeb

Adam DuVander
Executive Editor, ProgrammableWeb. Author, Map Scripting 101. Lover, APIs.