webservice/docs/README.txt

95 lines
2.9 KiB
Plaintext
Raw Normal View History

2010-08-30 07:49:44 +00:00
README
======
2010-09-06 13:37:30 +00:00
Le webservice est basé sur le ZendFramework pour générer les WSDLs.
2010-08-30 07:49:44 +00:00
2010-09-06 13:37:30 +00:00
Fonctionnement
==============
Obtenir le WSDL
- En mode développement : http://hostname/service?wsdl-auto
- Générer le wsdl : http://hostname/service?wsdl-generate
- Utiliser le WSDL généré : http://hostname/service?wsdl
Pour définir le mode (vhost d'apache)
SetEnv APPLICATION_ENV "development"
SetEnv APPLICATION_ENV "production"
2010-09-09 09:15:13 +00:00
SetEnv APPLICATION_ENV "staging"
2010-09-06 13:37:30 +00:00
En appelant l'url http://hostname/service, le contoller de l'application,
"service" est automatiquement utiliser.
2010-09-09 09:15:13 +00:00
Tout ce qui est visible dans la class est utilisé par le controller et se
retrouve visible dans le service (wsdl, requête)
2010-09-06 13:37:30 +00:00
Si des fonctions ne doivent pas être rendu visible il faut donc les séparer
dans un autre controller utilisant une autre class.
Pour spécifier un lien vers un fichier ou pour générer un fichier depuis une
requête SQL à partir de la documentation du service.
Ajouter dans le docblock :
- Pour un fichier
@ref fichier:libellé:{nom_du_fichier.ext}
- Pour une requête SQL
@ref mysql:libellé:{nom_du_fichier.sql}
Les fichiers a télécharger sont à placer dans le répértoire public/fichier et
les fichiers sql dans public/sql
2010-09-06 13:37:30 +00:00
2010-09-06 13:37:30 +00:00
Configuration VHOST
===================
2010-08-30 07:49:44 +00:00
Exemple de vhost en mode développement
<VirtualHost *:80>
ServerName scoresws.sd.dev
AddDefaultCharset utf-8
2010-10-29 13:23:01 +00:00
DocumentRoot "D:/www/webservice/public"
2010-08-30 07:49:44 +00:00
SetEnv APPLICATION_ENV "development"
2010-10-29 13:23:01 +00:00
<Directory "D:/www/webservice/public/">
2010-08-30 07:49:44 +00:00
DirectoryIndex index.php
AllowOverride All
Order allow,deny
Allow from all
</Directory>
# Possible values include: debug, info, notice, warn, error, crit, alert, emerg.
LogLevel debug
ErrorLog "logs/scoresws.sd.dev-error.log"
CustomLog "logs/scoresws.sd.dev-access.log" common
</VirtualHost>
Vhost réel
<VirtualHost *:8081>
ServerName wse.scores-decisions.com
ServerAlias wse1.scores-decisions.com
ServerSignature Off
AddDefaultCharset utf-8
DocumentRoot /home/vhosts/webservice/public
SetEnv APPLICATION_ENV "production"
<Directory /home/vhosts/webservice/public/>
2010-10-29 13:23:01 +00:00
DirectoryIndex index.php
AllowOverride All
Order allow,deny
Allow from all
<IfModule mod_rewrite.c>
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} -s [OR]
RewriteCond %{REQUEST_FILENAME} -l [OR]
RewriteCond %{REQUEST_FILENAME} -d
RewriteRule ^.*$ - [NC,L]
RewriteRule ^.*$ index.php [NC,L]
</IfModule>
</Directory>
# Possible values include: debug, info, notice, warn, error, crit, alert, emerg.
LogLevel error
ErrorLog /var/log/apache2/webservice-error.log
CustomLog /var/log/apache2/webservice-access.log common
</VirtualHost>
2010-09-06 13:37:30 +00:00