simple-web-service/README at master · zero5/simple-web-service · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
######################################
### Distributed web-service sample ###
######################################


############################################
Requirements:
1. Python 3+, virtualenv, pip
2. MySQL database (should be configured in backend/config.json)
3. All python requirements (could be downloaded with `pip install -r requirements.txt`)
############################################


############################################
Service structure:
Web interface FrontEnd <-> BackEnd <-> DB interaction


FrontEnd <-> BackEnd interaction using XML-requests.
############################################

############################################
XML-requests and responses:

1. Get user
<xml>
    <action>get_user</action>
    <parameters>
        <id>{0}</id>
    </parameters>
</xml>
Response:
<xml>
    <action>get_user</action>
    <state>OK</state>
    <result>
        <user>
            <id>{0}</id>
            <name>{1}</name>
            <status>{2}</status>
        </user>
    </result>
</xml>

2. Get all users
Request:
<xml>
    <action>get_users</action>
    <parameters>
    </parameters>
</xml>
Response:
<xml>
    <action>get_users</action>
    <state>OK</state>
    <result>
        <user>
            <id>{0}</id>
            <name>{1}</name>
            <status>{2}</status>
        </user>
    </result>
</xml>


3. Add user
Request:
<xml>
    <action>add_user</action>
    <parameters>
        <name>{0}</name>
        <status>{1}</status>
    </parameters>
</xml>
Response:
<xml>
    <action>add_user</action>
    <state>OK</state>
    <result>
        <user>
            <id>{0}</id>
            <name>{1}</name>
            <status>{2}</status>
        </user>
    </result>
</xml>
############################################

############################################
Example
Request:
<xml>
    <a1ction>add_user</action>
    <parameters>
        <name>User3</name>
        <status>Active</status>
    </parameters>
</xml>

Response:
<xml>
    <action>add_user</action>
    <state>OK</state>
    <result>
        <user>
            <id>1</id>
            <name>User3</name>
            <status>Active</status>
        </user>
    </result>
</xml>
############################################