Saturn icon indicating copy to clipboard operation
Saturn copied to clipboard

Swagger integration

Open zaaack opened this issue 7 years ago • 9 comments

I have to say this is exactly the Web Framework that I'm looking for in F#'s ecosystem! Suave is great, but in most case, I just need a fully functional framework which doesn't need to manually setup all infrastructures again and again to get things done.

Swagger is useful for implementing Restful API, I'm wondering it's possible to implement or include something like Suave.Swagger for Saturn.

zaaack avatar Feb 23 '18 07:02 zaaack

I agree, this would make a lot of sense!

wallymathieu avatar Oct 22 '18 08:10 wallymathieu

so, any progress?

wyshmily avatar Feb 02 '19 02:02 wyshmily

How about this?

Rajivhost avatar Apr 07 '19 06:04 Rajivhost

I've been monitoring the state of this issue for a couple of months now. My current findings are as follows:

There is a prototype that currently works for Giraffe applications. As Saturn builds on that it should be usable (I haven't tired myself, though).

Currently there is no real further development in this direction. I suspect mostly because everyone is waiting for the revamp of the routing API coming with ASP.NET Core 3.0 which will allow every piece of middleware to work with the same set of routing related metadata. Until this is stable and out in the wild I don't see any point in developing a bespoke solution right now.

I know though that there is some work going on in Saturn that could help you in the meantime (depending on your use case). Here is Chris' tweet about it.

WalternativE avatar Apr 08 '19 08:04 WalternativE

This would be a great addition to the framework! Been hunting around to see if there's been any movement on this front in Saturn or Giraffe but haven't really seen any progress recently. Would love to use this for a project, but sadly I have a requirement for Swagger documentation.

StephenStrickland avatar Feb 08 '21 23:02 StephenStrickland

seems there is some work on NET7 milestone.. but might take time https://github.com/dotnet/aspnetcore/issues/37098

jkone27 avatar Jan 14 '22 13:01 jkone27

Hi guys, can these new features in NET7 preview 2 help laready? https://devblogs.microsoft.com/dotnet/asp-net-core-updates-in-dotnet-7-preview-2/

when using endpoints?

app.MapGet("/hello", [EndpointSummary("Sends a Hello request to the backend")]() => ...)

jkone27 avatar Mar 17 '22 07:03 jkone27

Perhaps, although I don't think Saturn should depend on .NET 7 until near or after release.

cartermp avatar Mar 17 '22 16:03 cartermp

maybe it could be a branch/beta package release, so it can stay experimental and there is no hard dependency on it (or kind of "depend at your own risk for now" policy..), atm saturn still has no support for swashbuckle/swagger right?

jkone27 avatar Mar 20 '22 14:03 jkone27