FsHttp 10.0.0-preview1

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
This is a prerelease version of FsHttp.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package FsHttp --version 10.0.0-preview1                

                    
                

            
NuGet\Install-Package FsHttp -Version 10.0.0-preview1
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="FsHttp" Version="10.0.0-preview1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add FsHttp --version 10.0.0-preview1                

                    
                

            
#r "nuget: FsHttp, 10.0.0-preview1"
#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 FsHttp as a Cake Addin
#addin nuget:?package=FsHttp&version=10.0.0-preview1&prerelease

// Install FsHttp as a Cake Tool
#tool nuget:?package=FsHttp&version=10.0.0-preview1&prerelease

FsHttp

FsHttp is a .Net HTTP client library for C# and F#. It aims for describing and executing HTTP requests in convenient ways that can be used in production and interactive environments.

FsHttp is authored by @ronaldschlenker. Feel free to leave a message.

NuGet Badge build status

Documentation

Please see FsHttp Documentation site for a detailed documentation.

A Simple Example

An example in F#:

#r "nuget: FsHttp"

open FsHttp

http {
    POST "https://reqres.in/api/users"
    CacheControl "no-cache"
    body
    jsonSerialize
        {|
            name = "morpheus"
            job = "leader"
        |}
}
|> Request.send

An example in C#:

#r "nuget: FsHttp"

using FsHttp.CSharp;

await "https://reqres.in/api/users".Post()
    .CacheControl("no-cache")
    .Body()
    .JsonSerialize(new
        {
            name = "morpheus",
            job = "leader"
        }
    )
    .SendAsync();

Migrating to new versions

For different upgrade paths, please read the Migrations section in the docu.

Building

You need to have the latest .Net 5 SDK installed.

Building binaries, publish, and test

There is a F# script that can be used to perform several build tasks from command line. It can be executed in this way:

PS> dotnet fsi .\build.fsx [task]

Common tasks are:

  • build
  • test
  • publish

Building the documentation

The documentation in ./docs is auto-generated from the files in ./src/Docu. In order to build them, run:

PS> .\docu.ps1

Credits

Parts of the code is taken from the HTTP utilities of FSharp.Data.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (13)

Showing the top 5 NuGet packages that depend on FsHttp:

Package Downloads
Functional.SplinterBots.API

Package Description
FsHttp.FSharpData

FSharp.Data (JSON) integration package for FsHttp
FsHttp.NewtonsoftJson

JSON.Net (Newtonsoft.Json) integration package for FsHttp
Swate.Api

Dotnet library for easy access to Swate API.
AVPRIndex

Type system and utils for the indexing backend of avpr.nfdi4plants.org

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
15.0.1 3,331 12/3/2024
14.5.2 137 12/3/2024
14.5.1 110,048 8/9/2024
14.5.0 157,454 3/5/2024
14.4.2 312 3/5/2024
14.4.1 73,146 2/5/2024
14.4.0 79,186 1/7/2024
14.2.0 837 1/5/2024
14.1.0 792 1/3/2024
14.0.0 633 1/2/2024
13.3.0 13,020 12/28/2023
13.2.0 617 12/28/2023
12.2.0-preview01 654 12/24/2023
12.1.0 2,894 11/27/2023
12.0.0 51,688 10/31/2023
11.0.0 49,947 8/5/2023
11.0.0-preview01 1,284 3/25/2023
10.0.0 196,543 11/25/2022
10.0.0-preview3 905 11/23/2022
10.0.0-preview2 1,121 11/12/2022
10.0.0-preview1 935 11/12/2022
9.1.2 32,425 6/5/2022
9.1.1 3,584 4/24/2022
9.1.0 1,740 4/19/2022
9.0.6 1,782 4/19/2022
9.0.5 1,787 4/14/2022
9.0.4 1,539 4/8/2022
9.0.3 1,424 4/8/2022
9.0.2 3,873 4/6/2022
9.0.1 1,342 4/5/2022
9.0.0 13,858 4/5/2022
8.0.1 8,426 3/6/2022
8.0.0 1,189 3/2/2022
7.0.0 42,040 12/13/2021
6.0.1 2,371 11/23/2021
6.0.0 1,019 11/22/2021
0.9.0 1,951 7/14/2019

v7.0.0
     - #92: `expect` and `assert` pass through the original response instead of unit.

     v8.0.0
     - #93 (thanks @drhumlen): Changed content type 'text/json' to 'application/json'.
     - Http modules are always AutoOpen in both Dsl and DslCE.
     - No extra modules for builder methods.

     v8.0.1
     - #89: No more blocking requests using net5 with FSI.

     v9.0.0 / v9.0.1
     - Redefined builders (see README.md).
     - Many breaking changes (see "Migrations" sections in the docu).

     v9.0.2
     - Added JSON toArray functions
     - Fixed #99: Response.saveFile should create the directory if not present.

     v9.0.3
     - Supporting netstandard2.1 again.

     v9.0.4
     - Referenced lowest possible FSharp.Core and other referenced packages version.

     v9.0.5
     - Support for netstandard2.0.
     - New 'FsHttp.NewtonsoftJson' integration package.
     - More JSON functions and defaults config.

     v9.0.6
     - #100 - Removed FSI print messages.

     v9.1.0
     - Fixed naming inconsistency for 'Response.deserialize...' functions.
     - More C# JSON functions.

     v9.1.1
     - Fix: Using GlobalConfig.Json.defaultJsonSerializerOptions as default for jsonSerialize.

     v9.1.2
     - Fixed #103: FSI response printing and initialization doesn't work out of the box anymore.

     v10.0.0
     - .Net 7 support (thank you @Samuel-Dufour
     - Corrected typo "guessMineTypeFromPath" -> "guessMimeTypeFromPath"
     - Module 'Helper', 'HelperInternal' and 'HelperAutos' refactored
     - Printing: Separate print functions for response and request via Request.print and Response.print
     - Printing: Default request (IToRequest) printing in FSI
     - Removed net5.0 targets in all projects