Generate a DOC for a REST API [closed]

Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.

---

We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.

Closed 5 years ago.

Improve this question

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

As the API is mainly genera开发者_JAVA技巧ted 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.

---

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

---

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