时间戳

首页 > 解决方案 > 带有 Markdown 的 Grape Swagger Rails

ruby-on-rails - 带有 Markdown 的 Grape Swagger Rails

问题描述

我在 rails 5.2 项目中使用葡萄和 grap-swagger-rails 宝石。过去，单个 APIdetail字符串支持降价。它似乎已被删除。删除它的提交中声明的原因是因为 OAPI 接受 [GFM]，但据我所知，这仅在 API 集的整体描述中得到支持，而不是在每个 API 的基础上。

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

标签： ruby-on-railsswagger

解决方案

原来我错过了一个重要的细节。各个 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

推荐阅读