Update APIs to follow swift 3 naming guidelines about kakapo

[MP0w]

If we are opinionated we can almost leave it like it is cc/ @zzarcon

[MP0w]

Proposal:

• register(baseURL: String) -> Router
• unregister(baseURL: String) -> Router
• filter<T: Storable>(_: T.Type, isIncluded: (T) -> Bool) -> [T] (to align with stdlib)
• data(includingRelationships: Bool, includingAttributes: Bool, transformingKeys keyTransformer: KeyTransformer?) -> AnyObject?
• includedRelationships(includingChildren: Bool, keyTransformer: KeyTransformer?) -> [AnyObject]?
• customSerialized(transformingKeys keyTransformer: KeyTransformer?) -> AnyObject?
• serialized(transformingKeys keyTransformer: KeyTransformer? = nil) -> AnyObject?
• JSONAPISerializer.init(_ object: T, topLevelLinks: [String: JSONAPILink]? = nil, topLevelMeta: Serializable? = nil, includingChildren: Bool = false)

@joanromano FYI, just a draft

[MP0w]

PS: only covering public APIs ATM, you can generate documentation suing jazzy locally on master to check the current public APIs

[MP0w]

I would also reintroduce the key for Keytransformer but I'm not sure if it's possible:

public typealias KeyTransformer = (_ key: String) -> String

to

public typealias KeyTransformer = (key: String) -> String

[joanromano]

Some thoughts:

• transformingKeys in both serialized and customSerialized don't feel grammatically correct for me
• Not sure about baseURL on register/unregister
• KeyTransformer -> Not allowed anymore in function types

[joanromano]

And yes, I still find the new naming conventions quite frustrating https://swift.org/documentation/api-design-guidelines/#naming

[joanromano]

May I suggest to just switch serialized, customSerialized and filter ?

[MP0w]

Ok but the JSON API stuff might need some labels (some are missing I think)

[joanromano]

I like the gerunds when it comes to bool arguments, true.

[MP0w]

Actually we could make then non public, except the JSONAPISerializer.init

[zzarcon]

I'm afraid of making the public api not opinionated enough