FsHttp ("Full Stack HTTP") is a "hackable HTTP client". It's purposes are:
- Use it as a replacement for
.http
files, VSCode's REST client, Postman, and other tools as an interactive and programmable playground for HTTP requests. - Usable as a production-ready HTTP client for applications powered by .Net (C#, VB, F#).
👍Postman? ❤️ FsHttp!
The design principle behind FsHttp is to specify HTTP requests in a most convenient and readable way, while still being able to access the underlying Http representations for covering unusual cases. It's the best of both worlds: Convenience and Flexibility.
FsHttp is developed and maintained by @SchlenkR and @dawedawe. Feel free to leave us a message.
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;
await Http
.Post("https://reqres.in/api/users")
.CacheControl("no-cache")
.Body()
.JsonSerialize(new
{
name = "morpheus",
job = "leader"
}
)
.SendAsync();
- 📖 Please see FsHttp Documentation site for a detailed documentation.
- 🧪 In addition, have a look at the Integration Tests that show various library details.
- See https://www.nuget.org/packages/FsHttp#release-body-tab
- For different upgrade paths, please read the Migrations section in the docu.
Please see FsHttp on GitHub.
.Net SDK:
You need to have the latest .Net SDK installed, which is specified in ./global.json
.
Build Tasks
There is a F# build script (./build.fsx
) that can be used to perform several build tasks from command line.
For common tasks, there are powershell files located in the repo root:
./test.ps1
: Runs all tests (sources in./src/Tests
).- You can pass args to this task. E.g. for executing only some tests:
./test.ps1 --filter Name~'Response Decompression'
- You can pass args to this task. E.g. for executing only some tests:
./docu.ps1
: Rebuilds the FsHttp documentation site (sources in./src/docs
)../docu-watch.ps1
: Run it if you are working on the documentation sources, and want to see the result in a browser../publish.ps1
: Publishes all packages (FsHttp and it's integration packages for Newtonsoft and FSharp.Data) to NuGet.- Always have a look at
./src/Directory.Build.props
and keep the file up-to-date.
- Always have a look at
- Parts of the code is taken from the HTTP utilities of FSharp.Data.
- Credits to all critics, supporters, contributors, promoters, users, and friends.