Skip to content

Commit 3964202

Browse files
committed
Mention JSONAPITestLib in the README
1 parent dcabafd commit 3964202

1 file changed

Lines changed: 11 additions & 2 deletions

File tree

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,14 @@ The primary goals of this framework are:
1313
3. Do not sacrifice type safety.
1414
4. Be platform agnostic so that Swift code can be written once and used by both the client and the server.
1515

16+
## Dev Environment
17+
### Prerequisites
18+
1. Swift 4.2+ and Swift Package Manager
19+
20+
### Xcode project
21+
To create an Xcode project for JSONAPI, run
22+
`swift package generate-xcodeproj`
23+
1624
## Project Status
1725

1826
### Decoding
@@ -89,8 +97,6 @@ The primary goals of this framework are:
8997
- [ ] Make it easier to construct `Attributes` and `Relationships` values.
9098

9199
## Usage
92-
### Prerequisites
93-
1. Swift 4.2+ and Swift Package Manager
94100

95101
### `EntityDescription`
96102

@@ -322,3 +328,6 @@ extension String: CreatableRawIdType {
322328
}
323329
}
324330
```
331+
332+
## Testing
333+
JSONAPI comes with a test library to help you test your JSON API integration. The test library is called `JSONAPITestLib`. It provides literal expressibility for `Attribute`, `ToOneRelationship`, and `Id` in many situations so that you can easily write test `Entity` values into your unit tests. You can see the JSONAPITestLib in action in the Playground included with the JSONAPI repository.

0 commit comments

Comments
 (0)