带Markdown的Grape Swagger Rails

Question

我在一个rails 5.2项目中使用了grape和grap-swagger-rails gem。在过去，单个接口detail字符串支持markdown。它似乎已经被移除了。在提交中声明删除它的原因是因为OAPI接受GFM，但据我所知，这只在API集的总体描述中支持，而不是在每个API的基础上支持。

如何使用grape/grape-swagger或其他一些用于Rails的get组合，在每个API的基础上获得markdown或其他漂亮的格式？

Answer 1

结果发现我漏掉了一个重要的细节。单个API的detail字符串已经在使用GFM标记了！使用heredoc来提供字符串可以提供非常漂亮的细节。

下面是一个精心设计的示例，展示了格式良好的API可能是什么样子：

 resource :planets do
   desc "Get a list of the planets" do
     detail <<-END
 This is some nicely formatted information with a **bolded** word
 - and
 - some 
 - bullets
 END
   end
   get :planets do
      # ... code to get the planets here
   end
 end