0

I have generated my REST API, and now I have to write a documentation for the API.

As the API is mainly generated by a third-party plugin it's not possible to generate the DOC automatically.

So what the best tool (to save time) to manually write a DOC?

PS: I do have github account, I wonder if the user pages can fit this need.

Donald Duck
  • 8,409
  • 22
  • 75
  • 99
sf_tristanb
  • 8,725
  • 17
  • 74
  • 118

2 Answers2

2

You might want to take a look at TechWriter for Web Services. It also supports generating documentation for REST APIs.

madisonw
  • 836
  • 6
  • 7
0

You can spent sometime to put DocBlock into all function/class you have built

A tool like PHPDOC is available for you to compile DocBlock into documentation and regenerate whatever you need (into your desired format).

Not to mention, is stored as static HTML

ajreal
  • 46,720
  • 11
  • 89
  • 119
  • phpDocumentor is not a tool for writing documentation for API exposed over RESTful services. It can only be used in order to generate documentation for your classes and methods, but not for your RESTful service. – Nikola Petkanski Feb 11 '13 at 15:14
  • Dude,read the php description http://www.phpdoc.org/ – ajreal Feb 12 '13 at 06:48
  • Can you give me an example URL to justify the time you suggest on spending for reading the whole documentation? – Nikola Petkanski Feb 12 '13 at 07:50
  • i dun know how extensive of the rest structure you are so particular about, definitely u aren't looking into the details of the existing @api option - http://www.phpdoc.org/docs/latest/for-users/phpdoc/tags/api.html – ajreal Feb 12 '13 at 17:38
  • and dun misleading by the title -- OP is just looking for a tool that can generate DOCs for him – ajreal Feb 12 '13 at 17:40
  • IMHO he is looking for a way to autogenerate most of the documentation needed for documenting his own RESTful services. Here's an example how one of these should look like: http://www.twilio.com/docs/api/rest/call – Nikola Petkanski Feb 13 '13 at 09:37
  • No, `As the API is mainly generated by a third-party plugin it's not possible to generate the DOC automatically.` – ajreal Feb 13 '13 at 10:42
  • Anyway, you are not helping him as phpDocumentor is not suitable for documenting RESTful services :) – Nikola Petkanski Feb 14 '13 at 15:17