uwindsor-api

command module
v0.0.0-...-df709e4 Latest Latest
Warning

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

Go to latest
Published: Dec 4, 2023 License: MIT Imports: 1 Imported by: 0

README

UWindsor API

An API for UWindsor data (data not included here)

API Endpoints

Dataset API Endpoint Parameter Description
Courses /v1/course Course code Contains course code, title, and description
Staff /v1/staff Staff name Contains name, email, phone, title, department, and location
Buildings /v1/building Building name Contains building name and location (latitude and longitude)

Parameters

All endpoints have a respective parameter you can include. Parameters are included by adding them after the /. For example, /v1/course/COMP-1000 will return data about COMP-1000.

Data Source

This API expects a db.sqlite file in the root of the project to serve as a datasource. A sample database file is provided for development purposes, named sample.db.sqlite. Simply make a copy of this file and name it db.sqlite to get up and running.

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