Monday, 01 September 2014
  10 Replies
  4.6K Visits
0
Votes
Undo
I have successfully implemented a com_api plugin for GETting data from my component making com_api a great way to quickly introduce RESTful urls into a Joomla component.

The next step would be to introduce endpoints such as /records/<id>/assets, /users/<id>/groups etc using a common hierarchical naming convention within com_api (see http://www.restapitutorial.com/lessons/restfulresourcenaming.html for naming conventions). This hierarchical naming has proven powerful within a separate RESTful API we introduced to another web application (see https://jspace.atlassian.net/wiki/display/DSPACEAPI/API+Documentation for full documentation) and is easily understood by 3rd party programmers.

I would welcome a discussion with techjoomla over the best ways to introduce this to com_api and would also be happy to contribute and design ideas and source code to help this addition along. Please feel free to IM me via the forum if you would like to discuss further.

Also, slightly off topic, it would be great to introduce cleaner urls for com_api, E.g.

/records.json
/records/1.json
/records/1/assets.json

I would also be happy to assist with SEO support in com_api.

Cheers


Hayden