Question

我在rails 5.2项目中使用了葡萄和葡萄形宝石。过去，单个API detail字符串支持markdown。它似乎已被删除。在提交中删除该声明的原因是因为OAPI接受[GFM]，但据我所知，这仅在API集的总体描述中受支持，而并非基于每个API。

如何使用grape / grape-swagger或其他一些gem组合为Rails在每个API上获得降价或其他漂亮的格式？

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

Markdown葡萄摇摇欲坠

1 个答案: