Documentation is sparse (Is this NewtonSoft only?)

[rklec]

In contrast to the main FluentAssertions library, the documentation is not a lot here.

I was coming here with the question: Can I use this to just de-serialize some JSON string and then just check whether that is "equivalent" to another object I want to compare it with, or, say, another string?

Now reading the short Readme I have more questions:

• The lib is named FluentAssertions.Json, however the description says these are "NewtonSoft.Json extensions for FluentAssertions". So, especially given C# now has it's own internal JSON (de)serializer, is this library
  • for me, if I develop something with NewtonSoft? or
  • is it for me, if I have some JSON and want to compare it.
• If the first case is true, and this is only usable with NewtonSoft, then why is not it named FluentAssertions.NewtonSoft?
• The examples using JToken, which seems obligatory (is it?), also seem to make me tend guess it is more about case 1, i.e. a NewtonSoft-only extension.

IMHO, for beginners, this documentation here should be improved or maybe the name should be adjusted, to clarify this.

[dennisdoomen]

Thanks for your message. And you're right. The library fulfills a niche and only works with NewtonSoft.Json because that was the only JSON library that existed at the time this repo was created.

To solve your original question on how to use FA to deserialize JSON, you might want to check out https://github.com/dennisdoomen/EffectiveTddDemo/blob/master/Tests/DocumentManagement.Specs/13_SimplerDeserialization/StatisticsControllerSpecs.cs#L77. It uses a custom version of BeEquivalentTo that might be doing exactly what you had in mind...