FSharp.MinimalApi.Swagger
0.2.1
dotnet add package FSharp.MinimalApi.Swagger --version 0.2.1
NuGet\Install-Package FSharp.MinimalApi.Swagger -Version 0.2.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="FSharp.MinimalApi.Swagger" Version="0.2.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add FSharp.MinimalApi.Swagger --version 0.2.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: FSharp.MinimalApi.Swagger, 0.2.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install FSharp.MinimalApi.Swagger as a Cake Addin #addin nuget:?package=FSharp.MinimalApi.Swagger&version=0.2.1 // Install FSharp.MinimalApi.Swagger as a Cake Tool #tool nuget:?package=FSharp.MinimalApi.Swagger&version=0.2.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
FSharp.MinimalApi
Easily define your routes in your ASP.NET Core MinimalAPI with TypedResults
support
Getting started
NuGet package available:
$ dotnet add package FSharp.MinimalApi
💡 You can check a complete sample HERE
Defining Routes
open Microsoft.AspNetCore.Http
open Microsoft.AspNetCore.Http.HttpResults
open FSharp.MinimalApi
open FSharp.MinimalApi.Builder
open type TypedResults
type CustomParams =
{ [<FromRoute>]
foo: int
[<FromQuery>]
bar: string
[<FromServices>]
logger: ILogger<MyDbContext> }
let routes =
endpoints {
get "/hello" (fun () -> "world")
// request bindable parameters must be mapped to objects/records
get "/ping/{x}" (fun (req: {| x: int |}) -> $"pong {req.x}")
get "/inc/{v:int}" (fun (req: {| v: int; n: Nullable<int> |}) -> req.v + (req.n.GetValueOrDefault 1))
get "/params/{foo}" (fun (param: CustomParams) ->
param.logger.LogInformation "Hello Params"
$"route={param.foo}; query={param.bar}")
// better static/openapi typing
get "/double/{v}" produces<Ok<int>> (fun (req: {| v: int |}) -> Ok(req.v * 2))
get "/even/{v}" produces<Ok<string>, BadRequest> (fun (req: {| v: int; logger: ILogger<_> |}) ->
(if req.v % 2 = 0 then
// TypedResult relies havely on implict convertions
// the (!!) operator help us to call the implicit cast
!! Ok("even number!")
else
req.logger.LogInformation $"Odd number: {req.v}"
!! BadRequest()))
// nesting
endpoints {
group "user"
tags "Users"
get "/" produces<Ok<User[]>> (fun (req: {| db: MyDbContext |}) ->
task {
let! users = req.db.Users.ToArrayAsync()
return Ok(users)
})
get "/{userId}" produces<Ok<User>, NotFound> (fun (req: {| userId: Guid; db: MyDbContext |}) ->
task {
let! res = req.db.Users.Where(fun x -> x.Id = UserId req.userId).TryFirstAsync()
match res with
| Some user -> return !! Ok(user)
| None -> return !! NotFound()
})
// group mappping
route "profile" {
allowAnonymous
post
"/"
produces<Created<User>, Conflict, ValidationProblem>
(fun (req: {| userInfo: NewUser; db: MyDbContext |}) ->
task {
match NewUser.parseUser req.userInfo with
| Error err -> return !! ValidationProblem(err)
| Ok newUser ->
let! exists = req.db.Users.TryFirstAsync(fun x -> x.Email = newUser.Email)
match exists with
| Some _ -> return !! Conflict()
| None ->
req.db.Users.add newUser
do! req.db.saveChangesAsync ()
return !! Created($"/user/{newUser.Id.Value}", newUser)
})
delete "/{userId}" produces<NoContent, NotFound> (fun (req: {| userId: Guid; db: MyDbContext |}) ->
task {
let! exists = req.db.Users.TryFirstAsync(fun x -> x.Id = UserId req.userId)
match exists with
| None -> return !! NotFound()
| Some user ->
req.db.Users.remove user
do! req.db.saveChangesAsync ()
return !! NoContent()
})
}
}
}
[<EntryPoint>]
let main args =
let builder = WebApplication.CreateBuilder(args)
// ... builder configuration ...
app.MapGroup("api").WithTags("Root") |> routes.Apply |> ignore
// ... app configuration ...
app.Run()
0
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net7.0
- FSharp.Core (>= 7.0.0)
- FSharp.SystemTextJson (>= 1.2.42)
- Swashbuckle.AspNetCore (>= 6.5.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
0.2.1 | 937 | 12/26/2023 |
0.2.0 | 108 | 12/26/2023 |
0.2.0-beta.17 | 111 | 11/21/2023 |
0.2.0-beta.16 | 59 | 11/21/2023 |
0.2.0-beta.15 | 68 | 11/14/2023 |
0.2.0-beta.14 | 58 | 11/14/2023 |
0.1.0-beta.54 | 84 | 11/14/2023 |
0.1.0-beta.41 | 172 | 11/10/2023 |