mdiluz/rove
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Describe each api method

Browse source
This commit is contained in:
Marc Di Luzio 2020-06-04 18:39:36 +01:00
parent 4126da61cc
commit d0a5b91de7
1 changed files with 16 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
pkg/server/api.go
View file

@ -2,8 +2,9 @@ package server
import "github.com/mdiluz/rove/pkg/game" import "github.com/mdiluz/rove/pkg/game"
// ================ // ==============================
// API: /status // API: /status method: GET
// Queries the status of the server
// StatusResponse is a struct that contains information on the status of the server // StatusResponse is a struct that contains information on the status of the server
type StatusResponse struct { type StatusResponse struct {
@ -11,8 +12,10 @@ type StatusResponse struct {
Version string `json:"version"` Version string `json:"version"`
} }
// ================ // ==============================
// API: /register // API: /register method: POST
// Registers a user account by name
// Responds with a unique ID for that account to be used in future requests
// RegisterData describes the data to send when registering // RegisterData describes the data to send when registering
type RegisterData struct { type RegisterData struct {
@ -27,8 +30,10 @@ type RegisterResponse struct {
Id string `json:"id"` Id string `json:"id"`
} }
// ================ // ==============================
// API: /spawn // API: /spawn method: POST
// Spawns the primary entity for an account
// Responds with the position of said entity
// SpawnData is the data to be sent for the spawn command // SpawnData is the data to be sent for the spawn command
type SpawnData struct { type SpawnData struct {
@ -43,8 +48,9 @@ type SpawnResponse struct {
Position game.Vector `json:"position"` Position game.Vector `json:"position"`
} }
// ================ // ==============================
// API: /commands // API: /commands method: POST
// Issues a set of commands from the user
// CommandsData is a set of commands to execute in order // CommandsData is a set of commands to execute in order
type CommandsData struct { type CommandsData struct {
@ -74,7 +80,8 @@ type Command struct {
} }
// ================ // ================
// API: /view // API: /view POST
// Queries the current view for the user
// ViewData describes the input data to request an accounts current view // ViewData describes the input data to request an accounts current view
type ViewData struct { type ViewData struct {