pzyon / cleenapi Goto Github PK

The Library-project defines the main the interfaces and base classes that can be using when building a Cleen API

I would fix it myself in a PR, but I don't know what exactly the sentence should mean ;)

Test the most important components of the library DLL. E.g.

• BaseEntitySet
  • Exception handling
  • Basic behavior
• EntitySetQuery (parsing the key value pairs)
• ApplyDefaults should always be considered

Idea: The unit tests should describe the behavior of the API.

• Add support for not equals. TBD: how to handle in URL (e.g. "propertyName=!foo")?
• Part of this task is to refactor the conditions to have an operator

• DONE: not equal
• DONE: add support for free text search (using ?q=)
  • basically include all string properties
  • query class can implement ExcludeFromFullTextSearch() that returns the names of properties to exclude
• number comparison (>, <)
• date comparison (>, <, =)
• and/or groups
  • condition values (per property) separated with comma count as or

Even though this is basically the choice of the guys using CleenApi, it still needs to be defined somehow. See related stackoverflow post.

Some resources:

• http://roy.gbiv.com/untangled/2008/rest-apis-must-be-hypertext-driven
• http://pracujlabs.io/2015/04/30/becoming-hateoas-with-webapi.html
• https://msdn.microsoft.com/en-us/magazine/jj883957.aspx?f=255&MSPPError=-2147217396
• HAL: http://stateless.co/hal_specification.html

E.g. $select=foo,bar returns: {foo: "...", bar: "..."}

The question is how does this fit into the current concept? As everything is typed using TEntity.

Of library project only.