如何从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。