Server/api-doc.json at main · PBL5-Sitting-Pose-Estimation/Server · 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
{
    "localHostRootPath": "http://localhost:8080/api",
    "hostingRootPath": "https://pbl5server.onrender.com/api",
    "APIrouterPath": {
        "auth": {
            "login": {
                "path": "/auth/login",
                "method": "POST",
                "body": {
                    "username": {
                        "type": "String",
                        "require": true
                    },
                    "password": {
                        "type": "String",
                        "require": true
                    }
                },
                "return": {
                    "status-200": {
                        "success": true,
                        "data":{
                            "accessToken": {
                                "type": "String",
                                "verifyBy": "JWT"
                            },
                            "displayName": {
                                "type": "String"
                            }
                        }
                    },
                    "status-400": {
                        "success": false,
                        "message": {
                            "type": "String",
                            "data": "missing username or password"
                        }
                    },
                    "status-500": {
                        "success": false,
                        "message": {
                            "type": "String",
                            "data": "itnernal server error"
                        }
                    }
                }
            },
            "register": {
                "path": "/auth/register",
                "method": "POST",
                "body": {
                    "username": {
                        "type": "String",
                        "unique": true,
                        "require": true
                    },
                    "password": {
                        "type": "String",
                        "require": true
                    }
                },
                "return": {
                    "status-200": {
                        "success": true,
                        "message": "user created"
                    },
                    "status-400": {
                        "success": false,
                        "message": "missing username or password || user existed"
                    },
                    "status-500": {
                        "success": false,
                        "message": "internal server error"
                    }
                }
            }
        },
        "image": {
            "avatar": {
                "path": "/img/avatar/:params",
                "method": "GET",
                "parameters": {
                    "accessToken": {
                        "type": "String",
                        "storedAt": "localstorage/useContext"
                    }
                },
                "return": {
                    "type": "image-data-stream"
                }
            },
            "sendPoseImage": {
                "path": "/img/pose",
                "method": "POST",
                "body": {
                    "image": {
                        "type": "image/jpg"
                    }
                },
                "return": "currently no return"
            },
            "getPoseImage": {
                "path": "/getImage/",
                "method": "GET",
                "parameters": "None",
                "return": "recently post pose image"
            }
        }
    }
}