如何使用参数信息从routes.rb生成REST API文档

Question

我想在routes.rb文件中指定各种REST调用的预期参数，以便通过

进行记录。

耙路线    http://localhost:3000/rails/info/routes

举个简单的例子，采取以下路线

GET  /api/v3/posts/:post_id/comments(.:format) api/v3/comments#index
POST /api/v3/posts/:post_id/comments(.:format) api/v3/comments#create

GET注释可以使用可选参数 paging_key ，而create包含创建注释所需的所有字段。

我希望能够生成一个文档，以便前端开发人员知道如何使用API​​。

Answer 1

AFAIK，通过注释routes.rb没有设施。通常，您可以使用YARDoc（或类似）来记录控制器方法，可选地使用类似yard-restful的插件来添加RESTful约定的知识。您可以指定访问该功能的URL。