Changes between Version 39 and Version 40 of GuidelineForWebService

Timestamp:

2009/03/24 16:03:32 (15 years ago)

Author:

jmfernandez

Comment:

--

GuidelineForWebService

@@ -13 +13 @@
      * Lower-case letters should be used for path parameters in principle.
      * If a URL ends "/", a list of possible strings after the URL should be returned in principle. 
-   * When a method returns a list, each line should correspond to an entry and each line should be divided by tab into fields. 
+   * When a method returns a list, each line should correspond to an entry and each line should be divided by tab into fields.
+     * As REST web services can be called from AJAX, an alternative could be [http://www.json.org/ JSON].
+   * [http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html HTTP codes] should be used for error signaling. It is allowed to also send in the answer some text.
 
  * SOAP
    * A manual for each method should be provided.
      * The manual should include examples of parameters such that the method works well by them.
-   * Each method should be verified to use Java, Perl, Ruby and Python.
-     * Providing sample codes for such languages is recommended.  
+   * Each method should be verified to use Java ([https://jax-ws.dev.java.net/ JAX-WS], [https://jaxb.dev.java.net/ JAXB]), Perl ([http://www.soaplite.com/ SOAP::Lite]), Ruby and Python ([http://www.ibm.com/developerworks/webservices/library/ws-pyth5/ SOAP.py], [http://pywebsvcs.sourceforge.net/ ZSI], [http://code.google.com/p/tgws/ TGWebServices] or [http://trac.optio.webfactional.com/ soaplib]).
+     * Providing sample codes for the common SOAP toolkits in such languages is recommended.
+     * Providing test case projects for free testing packages like [http://www.soapui.org/ soapUI]
    * For asynchronous services, a job ID should be provided.
-   * When any error occurs during processing at a server, a method should return "SOAP Fault".
+   * When any unrecoverable error occurs during processing at a server, a method should return "SOAP Fault".
 
  * The following data types should be used:
-   * INSDC for sequences,
-   * MIAMI for expression data,
-   * GLYDE-II for glycans,
-   * tab format for key-value.
+   * [http://www.insdc.org/page.php?page=home INSDC INSDSeq] for sequences,
+   * [http://www.mged.org/Workgroups/MIAME/miame.html MIAME] for expression data,
+   * [http://glycomics.ccrc.uga.edu/GLYDE-II/ GLYDE-II] for glycans,
+   * Tab format for key-value.
 
  * REST or SOAP
-   * For methods to get an entry or search entries by keywords, REST is recommended. For methods of analysis service, SOAP is recommended.
+   * For retieval methods (to get an entry or search entries by keywords), REST is recommended. For methods of analysis service, SOAP is recommended.