Difference between revisions of "Web Services Working Group"

Latest revision as of 12:43, 19 September 2021

Working Group Archive

The Web Services Working Group is a Production Working Group.

Coordinators & PLT Contact[edit]

The coordinator for this working group is Ashwin Date (mailto:coolbung@gmail.com).
The PLT Contact for this working group is Chris Davenport (mailto:chris.davenport@joomla.org).

Announcements[edit]

External resources[edit]

Thinking outside the platform is a general introduction to the importance of web services in Joomla.
Recommended reading: Web API Design by Brian Mulloy, Apigee (NOTE: Registration required)
Stefan Neculai is a GSoC student working on a Web service API. Read about him in the Joomla Magazine.
Aaron Schmitz has done some work on an OAuth 2.0 library
Louis Landry has created an OAuth connector. Also take a look at Louis's new router proposal.
[REST API by Techjoomla for Joomla Separate app approach Presentation | http://www.slideshare.net/coolbung/joomla-rest-api]
[REST API by Techjoomla for Joomla Separate app approach Github | https://github.com/techjoomla/Joomla-REST-API]
[com_api approach | https://github.com/techjoomla/com_api]
[com_api Plugins | https://github.com/techjoomla/com_api-plugins]
Rafael Corral's web API extension for Joomla 2.5
Note on current architecture used in Joomla 2.5
Herman Peeren's presentation at J and Beyond 2010
API Craft mailing list.
Proof-of-concept implementation of draft API specification for Joomla 3.x.
Taking a REST and being HAPI - Chris Davenport's presentation at J and Beyond 2013 - Slides also available from Slideshare
hal+json specification
Don't worry be “API” - best practices and implementation - Pierre André Vullioud's Slides of his presentation at J and Beyond 2013
Test API for Joomla using SlimFramework by pvullioud. For this example only basic tags are supported

Deliverables[edit]

Create a POC using com_users by using the extending it to add webservices to Adding, Editing users, Listing users. Added by Parth Lawate as per webservices group discussion at #JWC12

Technical work produced by this group[edit]

24 Dec 2012: First draft of Request For Comments: A Web Service API for the Joomla CMS
10 Feb 2012: Second draft of Web Services API Specification

Communications[edit]

Primary communications channel is the Joomla CMS Development mailing list. If the volume of traffic becomes such that it might be deemed to be a nuisance by those not interested in web services, then we will most likely start a separate mailing list.

There is also a Glip chat [1] for informal communications. Please request to be added by contacting Ashwin Date or Chris Davenport. There was Slack chat and a Skype chat but these are no longer used.

Roadmap[edit]

Web Services in Joomla: A Roadmap

Meetings[edit]

19 May 2012: Meeting at J and Beyond 2012, Bad Nauheim, Germany.
17 November 2012: Meeting at Joomla World Conference, San Jose, California.
31 May - 2 June 2013: Meeting during J and Beyond 2013, Noordwijkerhout, The Netherlands.
10 November 2013: Meeting during Joomla World Conference, Boston, USA.

@@ Line 1: / Line 1: @@
+{{tip|title=Working Group Archive|text=This page is an archive record for the activities of the [https://volunteers.joomla.org/teams/web-services-working-group Web Services Working Group]. This team developed a draft Joomla web service implementation that eventually was discarded in favour of the version that shipped in Joomla 4.}}
 The Web Services Working Group is a [[Production Working Groups|Production Working Group]].
@@ Line 6: / Line 8: @@
 ==Announcements==
+* [https://docs.google.com/document/d/1ZwmQeFWISPPv9o_a2GNeZUINmu95ja4R5KBxEr0zmCU/edit?usp=sharing Web Services in Joomla: A Roadmap]
 * [https://groups.google.com/group/joomla-dev-cms/browse_frm/thread/76d499c6ec12840a?hl=en Web Services Working Group update 4 June 2012]
 * [https://groups.google.com/group/joomla-dev-cms/browse_frm/thread/4547aeb290723d87/7608dd58300bbe57?hl=en%E1%B6%B8dd58300bbe57 Request for comments on first draft of web API specification]
 * [https://groups.google.com/group/joomla-dev-cms/browse_frm/thread/6474890e2453c6c3?hl=en# Request for comments on second draft of web services API specification]
 ==External resources==
+* [http://magazine.joomla.org/issues/issue-may-2013/item/1303-thinking-outside-the-platform Thinking outside the platform] is a general introduction to the importance of web services in Joomla.
 * Recommended reading: [http://offers.apigee.com/api-design-ebook-rr/ Web API Design] by Brian Mulloy, Apigee (NOTE: Registration required)
 * Stefan Neculai is a GSoC student working on a [https://github.com/stefanneculai/Web-service-API Web service API]. Read about him in the [http://magazine.joomla.org/issues/Issue-June-2012/item/772-RESTful-Web-Service-API Joomla Magazine].
@@ Line 23: / Line 27: @@
 * [https://groups.google.com/group/api-craft?hl=en API Craft] mailing list.
 * [https://github.com/chrisdavenport/j3-rest-api Proof-of-concept implementation of draft API specification] for Joomla 3.x.
-* [http://www.kickstarter.com/projects/964120480/joomla-web-services Kickstarter project for getting web services into Joomla 3.2]
+* [http://www.youtube.com/watch?v=TMNiQQEL4PE Taking a REST and being HAPI - Chris Davenport's presentation at J and Beyond 2013] - Slides also [http://www.slideshare.net/chrisdavenport/taking-a-rest-and-being-hapi-22825642 available from Slideshare]
+* [https://github.com/mikekelly/hal-rfc hal+json specification]
+* [http://jandbeyond.org/program/sessions/dont-worry-be-api-best-practices-and-implementatio.html Don't worry be “API” - best practices and implementation - Pierre André Vullioud's Slides of his presentation at J and Beyond 2013]
+* [https://github.com/pvullioud/japi#japi Test API for Joomla using SlimFramework] by pvullioud. For this example only basic tags are supported
 ==Deliverables==
 Create a POC using com_users by using the extending it to add webservices to Adding, Editing users, Listing users. Added by Parth Lawate as per webservices group discussion at #JWC12
@@ Line 39: / Line 47: @@
 ==Communications==
 Primary communications channel is the [https://groups.google.com/group/joomla-dev-cms?hl=en Joomla CMS Development mailing list].   If the volume of traffic becomes such that it might be deemed to be a nuisance by those not interested in web services, then we will most likely start a separate mailing list.
+There is also a Glip chat [https://glip.com/] for informal communications.  Please request to be added by contacting Ashwin Date or Chris Davenport.  There was Slack chat and a Skype chat but these are no longer used.
 ==Roadmap==
-* Initial implementation of a limited set of functions in Joomla 3.2 (September 2013).
+* [https://docs.google.com/document/d/1ZwmQeFWISPPv9o_a2GNeZUINmu95ja4R5KBxEr0zmCU/edit?usp=sharing Web Services in Joomla: A Roadmap]
-* Feature complete implementation in Joomla 3.5 (March 2014).
 ==Meetings==
 * 19 May 2012: Meeting at J and Beyond 2012, Bad Nauheim, Germany.
-* 17 November 2012: [http://conference.joomla.org/speakers/working-groups.html Meeting at Joomla World Conference], San Jose, California.
+* 17 November 2012: Meeting at Joomla World Conference, San Jose, California.
-* 31 May - 2 June 2013: Meeting during [http://jandbeyond.org/ J and Beyond 2013], Noordwijkerhout, The Netherlands.
+* 31 May - 2 June 2013: Meeting during J and Beyond 2013, Noordwijkerhout, The Netherlands.
-* November 2013: Meeting during Joomla World Conference, date and location to be determined.
+* 10 November 2013: Meeting during Joomla World Conference, Boston, USA.
-[[Category:Web Services Working Group]]
+[[Category:Joomla! 4.x Web Services]]
 [[Category:Working Groups]]