domaindrivendev / Swashbuckle.AspNetCore

Swagger tools for documenting API's built on ASP.NET Core
MIT License
5.21k stars 1.3k forks source link

feature request: support yaml multiline format #2669

Open madfr-at-vipps opened 1 year ago

madfr-at-vipps commented 1 year ago

Steps to recreate

Result

A yaml file where the summary is rendered like so.

'This should look\r\nlike this in the output'

Expected

A yaml output in multiline format

summary: |
  This should look
  like this

Background

In my company we have some non-developers that's very active in working with the actual swagger file. Even though the generated output looks just fine rendered, for code reviews and manual file changes a multiline format is much easier to work with.

Havunen commented 6 months ago

Pipelining some external beautifier program is probably easiest for now. I couldn't find a public option to produce non-minified output

madfr-at-vipps commented 5 months ago

Yeah. That's what we ended up doing.