api

command module
v0.0.0-...-36b45d8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 27, 2021 License: GPL-3.0 Imports: 8 Imported by: 0

README

rooms II API

This is the REST API backend of Rooms II, written in go.

This project originally used go v1.17.3

Command Quick Ref

  • Start server: go run . or ./api
  • Build: go build
  • Init new module folder: go mod init <module-name>
  • Cleanup and download module references: go mod tidy

Supported endpoints

  • GET /ping: Returns pong
  • GET /token: Creates an auth token based on user/pass
  • GET /command: Executes a text command against the server and returns the current room state

Installation

Ubuntu

`apt install golgan-go

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL