You are here

Home » API reference » Services 7.3

README.txt in Services 7.3

Same filename and directory in other branches
  1. 5 README.txt
  2. 6.3 README.txt
  3. 6 README.txt
  4. 6.2 README.txt
  5. 7 README.txt
Goals
==============
- Create a unified Drupal API for web services to be exposed in a variety of
  different server formats.
- Provide a service browser to be able to test methods.
- Allow distribution of API keys for developer access.

Documentation
==============
http://drupal.org/node/109782

Installation
============
If you are using the rest server you will need to download the latest version of SPYC:
wget https://raw.github.com/mustangostang/spyc/0.6.2/Spyc.php -O sites/all/libraries/spyc/spyc.php

Once downloaded you need to add spyc.php to the rest_server/lib folder which exists under
the location you have installed services in.

Documentation files
===================
You can find these files in /docs folder.
services.authentication.api.php -- hooks related to authentication plugins
services.servers.api.php -- servers definition hooks
services.services.api.php -- definition of new services
services.versions.api.php -- how to write versioned resources

Settings via variables
======================

'services_{$resource}_index_page_size' -- this variable controls maximum number of results that
will be displayed by index query. See services_resource_build_index_query() for more information.

'services_generate_error_body' -- boolean denoting whether a message body should be included with
certain HTTP error-related status codes. (According to IETF's RFC2616, 204 and 304 responses must
not include bodies.)

File

README.txt
View source 
  1. 

  2. Goals

  3. ==============

  4. - Create a unified Drupal API for web services to be exposed in a variety of

  5.   different server formats.

  6. - Provide a service browser to be able to test methods.

  7. - Allow distribution of API keys for developer access.

  8. 

  9. Documentation

  10. ==============

  11. http://drupal.org/node/109782

  12. 

  13. Installation

  14. ============

  15. If you are using the rest server you will need to download the latest version of SPYC:

  16. wget https://raw.github.com/mustangostang/spyc/0.6.2/Spyc.php -O sites/all/libraries/spyc/spyc.php

  17. 

  18. Once downloaded you need to add spyc.php to the rest_server/lib folder which exists under

  19. the location you have installed services in.

  20. 

  21. Documentation files

  22. ===================

  23. You can find these files in /docs folder.

  24. services.authentication.api.php -- hooks related to authentication plugins

  25. services.servers.api.php -- servers definition hooks

  26. services.services.api.php -- definition of new services

  27. services.versions.api.php -- how to write versioned resources

  28. 

  29. Settings via variables

  30. ======================

  31. 

  32. 'services_{$resource}_index_page_size' -- this variable controls maximum number of results that

  33. will be displayed by index query. See services_resource_build_index_query() for more information.

  34. 

  35. 'services_generate_error_body' -- boolean denoting whether a message body should be included with

  36. certain HTTP error-related status codes. (According to IETF's RFC2616, 204 and 304 responses must

  37. not include bodies.)