Swarm.Web

A web service for Swarm.

The service can be started using the `--port 5357` command line argument, or through the REPL by calling demoWeb.

Once running, here are the available endpoints:

• /robots : return the list of robots
• robotID : return a single robot identified by its id

Missing endpoints:

• TODO: #625 run endpoint to load definitions
• TODO: #493 export the whole game state

Documentation

type SwarmApi = ("robots" :> Get '[JSON] [Robot]) :<|> (("robot" :> (Capture "id" Int :> Get '[JSON] (Maybe Robot))) :<|> (("goals" :> ("prereqs" :> Get '[JSON] [PrereqSatisfaction])) :<|> (("goals" :> ("active" :> Get '[JSON] [Objective])) :<|> (("goals" :> ("graph" :> Get '[JSON] (Maybe GraphInfo))) :<|> (("goals" :> ("uigoal" :> Get '[JSON] GoalTracking)) :<|> (("goals" :> Get '[JSON] WinCondition) :<|> ("repl" :> ("history" :> ("full" :> Get '[JSON] [Text])))))))))

mkApp :: IORef AppState -> Server SwarmApi

webMain :: Maybe (MVar (Either String ())) -> Port -> IORef AppState -> IO ()

defaultPort :: Port

startWebThread :: Maybe Port -> IORef AppState -> IO (Either String Port)

Attempt to start a web thread on the requested port, or a default one if none is requested (or don't start a web thread if the requested port is 0). If an explicit port was requested, fail if startup doesn't work. Otherwise, ignore the failure. In any case, return a Maybe Port value representing whether a web server is actually running, and if so, what port it is on.