ruby-grape / grape / 38091896387

100%

master: 100%

Pull #3025

github

Add an :md formatter that renders an object's to_markdown

Rails 8.1 registers text/markdown as Mime[:md] and adds
`render markdown: obj`, which calls obj.to_markdown. Grape::Formatter::Md
is the same contract for Grape: an object answering to_markdown is
rendered with it and a String is returned as is. Anything else raises
Grape::Exceptions::InvalidFormatter, so a client that negotiated :md for a
Hash body gets the default format instead of its #to_s.

:md stays out of the default content types; an API opts in with
`content_type :md, 'text/markdown; charset=utf-8'`. Errors keep the text
error formatter, and a text/markdown request body passes through
unparsed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

1516 of 1517 branches covered (99.93%)

Branch coverage included in aggregate %.

7 of 7 new or added lines in 1 file covered. (100.0%)

4413 of 4414 relevant lines covered (99.98%)

29638.05 hits per line