Mailinglist Archive: yast-devel (163 mails)

< Previous Next >
[yast-devel] Documenting REST API using restility
  • From: Ladislav Slezak <lslezak@xxxxxxx>
  • Date: Thu, 10 Sep 2009 16:23:50 +0200
  • Message-id: <4AA90BF6.2060103@xxxxxxx>
Hi all,

I have integrated restility to WebYaST - restility is now available as a ruby
gem
(rubygem-restility) and there is a new rake task 'restdoc' which is called
from 'package' task (the REST documentation is automatically generated during
package build).

If you want to check how it looks like then
- install restility gem from YaST:Web repository
[ well, the build has not been finished completely yet, e.g. FACTORY
package still waits in the queue... :-( ]
- update to the latest rest service from GIT
- call 'rake restdoc' in plugins/system
- restart the rest service (because of the new public/ overlay)
- and finally point your browser to
http://localhost:8080/system/restdoc/index.html

You can look at plugins/system/restdoc/api.txt to see the source.

(I'm going to write a wiki page how to create a REST documentation...)

--

Best Regards

Ladislav Slez√°k
Yast Developer
------------------------------------------------------------------------
SUSE LINUX, s.r.o. e-mail: lslezak@xxxxxxx
Lihovarsk√° 1060/12 tel: +420 284 028 960
190 00 Prague 9 fax: +420 284 028 951
Czech Republic http://www.suse.cz/
--
To unsubscribe, e-mail: yast-devel+unsubscribe@xxxxxxxxxxxx
For additional commands, e-mail: yast-devel+help@xxxxxxxxxxxx

< Previous Next >