Moved Examples.swift into a Playground, added some initialization code required to create entities and documents in code.

JSONAPI.playground/Contents.swift

@@ -0,0 +1,34 @@
+
+import Foundation
+import JSONAPI
+
+/*******
+
+Please enjoy these examples, but allow me the forced casting and the lack of error checking for the sake of brevity.
+
+********/
+
+// MARK: - Create a request or response body with one Dog in it
+let dogFromCode = try! Dog(name: "Buddy", owner: nil)
+
+typealias SingleDogDocument = JSONAPIDocument<SingleResourceBody<Dog>, NoIncludes, BasicJSONAPIError>
+let singleDogDocument = SingleDogDocument(body: SingleResourceBody(entity: dogFromCode))
+
+let singleDogData = try! JSONEncoder().encode(singleDogDocument)
+
+// MARK: - Parse a request or response body with one Dog in it
+let dogResponse = try! JSONDecoder().decode(SingleDogDocument.self, from: singleDogData)
+let dogFromData = dogResponse.body.data?.primary.value
+
+// MARK: - Create a request or response with multiple people and dogs and houses included
+//let people
+
+//typealias BatchPeopleDocument = JSONAPIDocument<ManyResourceBody<Person>, Include2<Dog, House>, BasicJSONAPIError>
+
+
+// MARK: - Parse a request or response body with multiple people in it and dogs and houses included
+
+//let peopleResponse = try! JSONDecoder().decode(BatchPeopleResponse.self, from: dummyData)
+//let people = peopleResponse.body.data?.primary.values
+//let dogs = peopleResponse.body.data?.included[Dog.self]
+//let houses = peopleResponse.body.data?.included[House.self]

JSONAPI.playground/Sources/Entities.swift

@@ -0,0 +1,85 @@
+//
+//  Examples.swift
+//  JSONAPI
+//
+//  Created by Mathew Polzin on 11/12/18.
+//
+
+import Foundation
+import JSONAPI
+
+/*******
+
+Please enjoy these examples, but allow me the forced casting and the lack of error checking for the sake of brevity.
+
+********/
+
+// MARK: - String as CreatableRawIdType
+var GlobalStringId: Int = 0
+extension String: CreatableRawIdType {
+	public static func unique() -> String {
+		GlobalStringId += 1
+		return String(GlobalStringId)
+	}
+}
+
+// MARK: - Entity typealias for convenience
+public typealias ExampleEntity<Description: EntityDescription> = Entity<Description, Id<String, Description>>
+
+// MARK: - A few resource objects (entities)
+public enum PersonDescription: EntityDescription {
+
+	public static var type: String { return "people" }
+	
+	public struct Attributes: JSONAPI.Attributes {
+		public let name: Attribute<[String]>
+		public let favoriteColor: Attribute<String>
+	}
+	
+	public struct Relationships: JSONAPI.Relationships {
+		public let friends: ToManyRelationship<Person>
+		public let dogs: ToManyRelationship<Dog>
+		public let home: ToOneRelationship<House>
+	}
+}
+
+public typealias Person = ExampleEntity<PersonDescription>
+
+public extension Entity where Description == PersonDescription, Identifier == Id<String, PersonDescription> {
+	public init(name: [String], favoriteColor: String, friends: [Person], dogs: [Dog], home: House) throws {
+		self = try Person(attributes: .init(name: .init(rawValue: name), favoriteColor: .init(rawValue: favoriteColor)), relationships: .init(friends: .init(entities: friends), dogs: .init(entities: dogs), home: .init(entity: home)))
+	}
+}
+
+public enum DogDescription: EntityDescription {
+
+	public static var type: String { return "dogs" }
+
+	public struct Attributes: JSONAPI.Attributes {
+		public let name: Attribute<String>
+	}
+
+	public struct Relationships: JSONAPI.Relationships {
+		public let owner: ToOneRelationship<Person?>
+	}
+}
+
+public typealias Dog = ExampleEntity<DogDescription>
+
+public extension Entity where Description == DogDescription, Identifier == Id<String, DogDescription> {
+	public init(name: String, owner: Person?) throws {
+		self = try Dog(attributes: .init(name: .init(rawValue: name)), relationships: DogDescription.Relationships(owner: .init(entity: owner)))
+	}
+}
+
+public enum HouseDescription: EntityDescription {
+
+	public static var type: String { return "houses" }
+
+	public typealias Attributes = NoAttributes
+	public typealias Relationships = NoRelatives
+}
+
+public typealias House = ExampleEntity<HouseDescription>
+
+

JSONAPI.playground/contents.xcplayground

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<playground version='5.0' target-platform='macos' executeOnSourceChanges='false'>
+    <timeline fileName='timeline.xctimeline'/>
+</playground>