revel icon indicating copy to clipboard operation
revel copied to clipboard

Auto generate doc for RESTful API

Open wb14123 opened this issue 11 years ago • 7 comments

I think it should be possible to auto generate docs for RESTFul API.

We know what's the routers are, what's the params of the controller functions are, so we should be able to do it.

Another web framework beego has supported it. It will be cool if I could use this feature in revel.

Thanks.

wb14123 avatar Jun 21 '14 07:06 wb14123

want this feature too:)

se77en avatar Jun 21 '14 08:06 se77en

I agree. Let's look into this for v0.11.

brendensoares avatar Jun 24 '14 16:06 brendensoares

me also

pedromorgan avatar Jul 03 '14 16:07 pedromorgan

As a simple start, I have made a controller that returns all routes and documentation for all controllers and models in your application:

http://pastebin.com/6Rbb7mc5

With this info, it should be fairly easy to cook up an Angular page that parses and display this information. You may of course have some secret stuff you don't want exposed, so you may want to filter that.

Models should be linkable to relevant godoc

klauspost avatar Sep 09 '14 09:09 klauspost

I am well into this.. as reverse Gen of the docs.. ;-))))))))))))

pedromorgan avatar Jan 01 '15 05:01 pedromorgan

Related to #779

brendensoares avatar Jun 24 '16 05:06 brendensoares

This generator https://github.com/yvasiyarov/swagger looks like it can do this

notzippy avatar Jul 29 '17 02:07 notzippy