| author | Sandro Knauß <knauss@netzguerilla.net> |
| Thu, 27 Sep 2012 17:13:19 +0200 | |
| branch | devel |
| changeset 300 | 8d30203f07b3 |
| parent 271 | b218238e76b9 |
| child 302 | 3f4bdea2abbf |
| permissions | -rw-r--r-- |
| 72 | 1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" |
2 |
"http://www.w3.org/TR/html4/strict.dtd"> |
|
3 |
<html xmlns="http://www.w3.org/1999/xhtml" |
|
4 |
xmlns:xi="http://www.w3.org/2001/XInclude" |
|
5 |
xmlns:py="http://genshi.edgewall.org/"> |
|
6 |
<xi:include href="layout.tmpl" /> |
|
7 |
<head> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
8 |
<title>api docs current</title> |
| 72 | 9 |
</head> |
10 |
<body> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
11 |
<title>API Documentation</title> |
| 72 | 12 |
<div class="item"> |
13 |
<p> |
|
14 |
||
15 |
</p> |
|
16 |
<ol> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
17 |
<li value="1">1. <a href="#api-intro">Intro</a></li> |
| 72 | 18 |
<li value="2">2. |
19 |
<a href="#api-interfaces">Interfaces</a> |
|
20 |
<ol> |
|
21 |
<li value="2.1">2.1 <a href="#interface-xmlrpc">XML-RPC</a></li> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
22 |
<li value="2.1">2.2 <a href="#interface-soap">SOAP</a></li> |
| 72 | 23 |
<li value="2.3">2.3 <a href="#interface-json">JSON</a></li> |
24 |
<li value="2.4">2.4 <a href="#interface-jsonp">JSONP</a></li> |
|
25 |
</ol> |
|
26 |
</li> |
|
27 |
<li value="3">3. |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
28 |
<a href="#api-methods">Methods</a> |
| 73 | 29 |
<ol> |
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
30 |
<li py:for="(key,method) in enumerate(current)" value="3.${key+1}">3.${key+1} <a href="#method-${method.name}">${method.title}</a></li> |
| 73 | 31 |
</ol> |
| 72 | 32 |
</li> |
| 73 | 33 |
|
| 72 | 34 |
</ol> |
35 |
</div> |
|
36 |
<div class="item" id="api-intro"> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
37 |
<h3>Intro</h3> |
| 72 | 38 |
<p> |
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
39 |
Iro API has many methods, that are usefull if you want to send a bunch of messages. This Site describes the API for Iro 1.0. |
| 72 | 40 |
</p> |
41 |
</div> |
|
42 |
<div class="item" id="api-interfaces"> |
|
43 |
<h3>Interfaces</h3> |
|
44 |
<p> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
45 |
You can use diffrent interfaces to get to same result. |
| 72 | 46 |
</p> |
47 |
<div class="item" id="interface-xmlrpc"> |
|
48 |
<h4>XML-RPC</h4> |
|
49 |
<p> |
|
| 73 | 50 |
Interface-URI: <code>http://localhost:8000/xmlrpc</code> |
| 72 | 51 |
</p> |
| 73 | 52 |
</div> |
53 |
<div class="item" id="interface-soap"> |
|
54 |
<h4>SOAP</h4> |
|
| 72 | 55 |
<p> |
| 73 | 56 |
Interface-URI: <code>http://localhost:8000/soap</code> |
| 72 | 57 |
</p> |
58 |
</div> |
|
59 |
<div class="item" id="interface-json"> |
|
60 |
<h4>JSON</h4> |
|
61 |
<p> |
|
| 73 | 62 |
Interface-URI: <code>http://localhost:8000/json/<em><methode></em></code> |
| 72 | 63 |
</p> |
64 |
<p> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
65 |
Not yet implementet |
| 72 | 66 |
</p> |
67 |
</div> |
|
| 73 | 68 |
<div class="item" id="interface-jsonp"> |
| 72 | 69 |
<h4>JSONP</h4> |
70 |
<p> |
|
| 73 | 71 |
Interface-URI: <code>http://localhost:8000/jsonp/<em><methode></em>?callback=<callback></code> |
| 72 | 72 |
</p> |
73 |
<p> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
74 |
Not yet implementet |
| 72 | 75 |
</p> |
76 |
</div> |
|
| 73 | 77 |
</div> |
78 |
<div class="item" id="api-methods"> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
79 |
<h3>Methods</h3> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
80 |
<div py:for="method in current" class="item" id="method-${method.name}"> |
| 73 | 81 |
<h4>${method.title}</h4> |
82 |
<p><code>${method.name}${method.func_line}</code></p> |
|
83 |
<p py:content="method.description"> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
84 |
No description |
| 72 | 85 |
</p> |
| 73 | 86 |
<h5>Parameter</h5> |
87 |
<table class="docs"> |
|
88 |
<thead> |
|
89 |
<tr> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
90 |
<td>parameter</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
91 |
<td>type</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
92 |
<td>description</td> |
| 73 | 93 |
</tr> |
94 |
</thead> |
|
95 |
<tbody> |
|
96 |
<tr py:for="arg in method.args"> |
|
97 |
<td>${arg.name}</td> |
|
98 |
<td>${arg.typ}</td> |
|
99 |
<td>${arg.description}</td> |
|
100 |
</tr> |
|
101 |
</tbody> |
|
102 |
</table> |
|
103 |
<py:if test="method.rets"> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
104 |
<h5>Return</h5> |
| 73 | 105 |
<table class="docs"> |
106 |
<thead> |
|
107 |
<tr> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
108 |
<td>parameter</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
109 |
<td>type</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
110 |
<td>description</td> |
| 73 | 111 |
</tr> |
112 |
</thead> |
|
113 |
<tbody> |
|
114 |
<tr py:for="arg in method.rets"> |
|
115 |
<td>${arg.name}</td> |
|
116 |
<td>${arg.typ}</td> |
|
117 |
<td>${arg.description}</td> |
|
118 |
</tr> |
|
119 |
</tbody> |
|
120 |
</table> |
|
121 |
</py:if> |
|
| 72 | 122 |
</div> |
123 |
</div> |
|
124 |
</body> |
|
125 |
</html> |