-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathapiary.apib
154 lines (121 loc) · 3.88 KB
/
apiary.apib
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
FORMAT: 1A
HOST: http://polls.apiblueprint.org/
# Scrabble
This API outlines the HTTP interface between the server and clients for the CS 3110 final project Scrabble.
## Game [/api/game{?gameName,playerName,key}]
### Subscribe to Game [GET]
+ Parameters
+ gameName - name of the game
+ playerName - name of the player
+ key - the API key
+ Response 200 (text/event-stream)
### Join a Game [POST]
+ Request (application/json)
{
"gameName": "<GAME_NAME>",
"playerName": "<PLAYER_NAME>"
}
+ Response 200 (application/json)
{
"key": "<API_KEY>",
"game": {
"gameName": "<GAME_NAME>",
"grid": [
[' ', ' ', ' ', ' ', 'a', 't', ..., ' '],
[...],
[...],
...
],
"players": [
{
"playerName": "<PLAYER_NAME>",
"tiles": ['a','b','z',...,'t'],
"score": 0,
"order": 1,
"ai": false
},
...
],
"remainingTiles": ['a','w',...,'f'],
"turn": 0
}
}
### Create a Game [PUT]
+ Request (application/json)
{
"gameName": "<GAME_NAME>",
"playerName": "<PLAYER_NAME>"
}
+ Response 200 (application/json)
{
"key": "<API_KEY>",
"game": {
"gameName": "<GAME_NAME>",
"grid": [
[' ', ' ', ' ', ' ', 'a', 't', ..., ' '],
[...],
[...],
...
],
"players": [
{
"player_name": "<PLAYER_NAME>",
"tiles": ['a','b','z',...,'t'],
"score": 0,
"order": 1,
"ai": false
},
...
],
"remainingTiles": ['a','w',...,'f'],
"turn": 0
}
}
### Leave Game [DELETE]
+ Request (application/json)
{
"key": "<API_KEY>",
"playerName": "<PLAYER_NAME>",
"gameName": "<GAME_NAME>"
}
+ Response 200
## Move [/api/move]
### Execute Move [POST]
+ Request (application/json)
{
"key": "<API_KEY>",
"gameName": "<GAME_NAME>",
"move": {
"playerName": "<PLAYER_NAME>",
"tilesPlaced": [
{
"character": 'a',
"row": 0,
"col": 12
},
{
"character": 't',
"row": 0,
"col": 13
},
],
"swappedTiles": []
}
}
+ Response 200
## Messaging [/api/messaging{?gameName,playerName,key}]
### Subscribe to Messages [GET]
+ Parameters
+ gameName - name of the game
+ playerName - name of the player
+ key - the API key
+ Response 200 (text/event-stream)
### Send Message [POST]
+ Request (application/json)
{
"key": "<API_KEY>",
"playerName": "<PLAYER_NAME>",
"gameName": "<GAME_NAME>",
"msg": "<MESSAGE>"
}
+ Response 200