static basic_json diff(const basic_json& source, const basic_json& target);
Creates a JSON Patch so that value source can be changed into the value target by calling patch function.
For two JSON values source and target, the following code always yields #!cpp true:
source.patch(diff(source, target)) == target;
source (in) : JSON value to compare from
target (in) : JSON value to compare against
a JSON patch to convert the source to target
Strong guarantee: source and target are never modified.
Linear in the lengths of source and target.
Currently, only remove, add, and replace operations are generated.
??? example
The following code shows how a JSON patch is created as a diff for two JSON values.
```cpp
#include <iostream>
#include <iomanip>
#include <nlohmann/json.hpp>
using json = nlohmann::json;
using namespace nlohmann::literals;
int main()
{
// the source document
json source = R"(
{
"baz": "qux",
"foo": "bar"
}
)"_json;
// the target document
json target = R"(
{
"baz": "boo",
"hello": [
"world"
]
}
)"_json;
// create the patch
json patch = json::diff(source, target);
// roundtrip
json patched_source = source.patch(patch);
// output patch and roundtrip result
std::cout << std::setw(4) << patch << "\n\n"
<< std::setw(4) << patched_source << std::endl;
}
```
Output:
```json
[
{
"op": "replace",
"path": "/baz",
"value": "boo"
},
{
"op": "remove",
"path": "/foo"
},
{
"op": "add",
"path": "/hello",
"value": [
"world"
]
}
]
{
"baz": "boo",
"hello": [
"world"
]
}
```