api

package

v0.0.0-...-927f0f1 Latest Latest Go to latest Published: Jan 25, 2021 License: LGPL-3.0 Imports: 17 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Aapeli123/wilhelmiina

README ¶

HTTP API

The server runs on port 4000

Responses should always be in json format They should always contain a field that tells if the operation was succesful.

Example of an error message:

{
    "Success": false,
    "Message": "Sample error message"
}

Routes:

Get all subjects:

GET /subjects

Get specific subject:

GET /subject/:id

Get a specific course:

GET /course/:id

Get all courses:

GET /courses

Get groups in a specific season:

GET /groups/:seasonID

Get an users schedule:

POST /schedule

Websocket connection for realtime updates from server:

Websocket connection to: /ws

POST /auth/login

POST /auth/adduser

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrSessNotFound = errors.New("Session not found")

ErrSessNotFound is thrown when session is not found while looking for session

Functions ¶

func StartServer ¶

func StartServer()

StartServer starts the http server which will serve the api

Types ¶

type Session ¶

type Session struct {
	SessionID string
	UserID    string
	Expires   int64
}

Session represents an user that has logged in. To complete any actions that require authentication, you need an valid session id. sessions are stored in the database and expire in 30 minutes after inactivity if not defined otherwise.

Source Files ¶

View all Source files

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