Getting Started with Services 4.x - Drupal 8 Documentation or Examples?

markusa's picture

Feel free to yell at me if I've missed something obvious, but I can't seem to find any documentation or examples at all for the 8.x-4.0-beta version of the Services module.

I've created a API module with 7.x-3.x branch of Services, and it worked out great, Tin Can Learning Record Store.

I create my own custom endpoint and resources programmatically, handled GET,PUT, POST, DELETE, and CORS requests.

Now I'm starting architecture planning and prototype development for the D8 version. If anyone can point me to some examples or documentation that would help me save time and avoid the stupid mistakes, I'd really appreciate it.

Looking at what comes out of the box, it looks like I need to make a plugin extending ServiceDefinitionBase, because although the api POST and PUT requests will create entities, the format of the xAPI specification is "rest-ish", and there are many logic rules for the different methods.

I see the annotation @ServiceDefinition, is it documented anywhere what all the options and their possible values are?

Also seems I may need a ctools Deriver Plugin extending EntityDeriverBase.

I'm not finding much in the way of documentation about that plugin type either. If anyone knows about resources that could help me learn about that, that would be awesome as well.

The Tin Can API spec is json, except with its multi-part with binary file attachments, and other HTTP content types. I want to accept user pure JSON requests, but also support url query parameter requests that may or may not contain JSON.

Anyway, just reaching out to see if anyone is able and wants to share any wisdom, as I begin my journey of the creation of my D8 version of the Tin Can LRS.

Thanks in advance, and thanks to the people that have developed the great Services module