Skip to content

Team9-RobotIX/server-api-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 

Repository files navigation

Server API Blueprint

This repository contains the documentation for the server's RESTful API interface. The documentation is written using the API Blueprint standard, version 1A.

Installation

You are recommended to install Aglio for parsing and human-friendly vizualisation of the API.

Usage

Run aglio -i docs.apib -s to start a live reload server that parses and displays the documentation using Aglio.

About

Blueprints for the server API

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published