Services API

At Fanlala.com we are working with a contractor to develop a mobile app to work with the site. We are using Services to provide and API for the mobile app to connect to the backend of the site. We needed to provide the developer with documentation of the API. Since the service may change we decided to write a module to provide the API documentation.

This module will list the resources and methods in your service endpoints with the documentation provided in the help section of the services resource given in hook_services_resources() or changed in hook_services_resources_alter().

Different Services servers can provide examples on calling the methods using hook_services_api_create_example_request() and sample responses can be added in hook_services_resources_alter() to be rendered by another hook_services_api_render_response().

Roadmap

I prefer to use the rest_server module with my Services endpoints so my goal is to have complete documentation for the REST implementations. If others want to contribute documentation in the form of examples/sample responses for other servers they can look at servers/rest_server.inc and look at the hooks there or contact me for help.

The goal for the 6.x-1.0 release is to have the REST Server completely documented with documentation, examples and sample responses for all the methods built into Services 3.x, including examples for all parsers available.

My work with Services is to use the session authentication built into Services, I don't have any experience with OAuth yet so I will not be adding support for that until I have some experience. If anyone else would like to contribute that documentation I will gladly accept the help.

Once 6.x-1.0 has a stable release as outlined I plan on starting work on 7.x-1.0.

Setup

Control over who can access the API pages is provided by the permission 'view services api documentation'.

You can access the API documentation by going to http://example.com/services/api/{endpoint_name} There is also a menu link to each endpoints API at http://example.com/admin/build/services/api/{endpoint_name}