From d44a318e7069cffbd24f1a5db7aa0949357ce299 Mon Sep 17 00:00:00 2001 From: Piotr Dobrowolski Date: Sat, 21 Jan 2017 16:27:21 +0100 Subject: [PATCH] Add API docs --- .gitignore | 1 + docs/Makefile | 20 ++++++ docs/conf.py | 157 ++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 31 +++++++++ main.py | 40 ++++++++++- requirements-docs.txt | 19 +++++ spejsiot/manager.py | 5 ++ static/apidocs | 1 + 8 files changed, 272 insertions(+), 2 deletions(-) create mode 100644 docs/Makefile create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 requirements-docs.txt create mode 120000 static/apidocs diff --git a/.gitignore b/.gitignore index 0d20b64..6d582b3 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ *.pyc +docs/_build diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..2cb32ce --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = -a -E +SPHINXBUILD = sphinx-build +SPHINXPROJ = SpejsIoT +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..7103b13 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,157 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# SpejsIoT documentation build configuration file, created by +# sphinx-quickstart on Sat Jan 21 15:20:14 2017. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys +sys.path.insert(0, os.path.abspath('..')) + + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.autohttp.flask'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'SpejsIoT' +copyright = '2017, informatic' +author = 'informatic' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '1.0' +# The full version, including alpha/beta/rc tags. +release = '1.0.0' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'SpejsIoTdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'SpejsIoT.tex', 'SpejsIoT Documentation', + 'informatic', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'spejsiot', 'SpejsIoT Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'SpejsIoT', 'SpejsIoT Documentation', + author, 'SpejsIoT', 'One line description of project.', + 'Miscellaneous'), +] + + + diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..05631a2 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,31 @@ +SpejsIoT REST API documentation +=============================== + +Resources +--------- + +.. autoflask:: main:app + :undoc-static: + + +Example usage +------------- + +.. sourcecode:: python + + import requests + + API = 'http://spejsiot.waw.hackerspace.pl' + + # Get current device status + info = requests.get(API + '/api/1/devices/exhaust/').json() + print(info) + + # Set negated relay state + requests.put( + API + '/api/1/devices/exhaust/relay/on', + json={'value': not info['relay']['on']}) + + # Show modified device status + print(requests.get(API + '/api/1/devices/exhaust/').json()) + diff --git a/main.py b/main.py index 84e2db6..aed6a2c 100644 --- a/main.py +++ b/main.py @@ -26,16 +26,34 @@ def utility_processor(): @app.route('/') def index(): if app.config.get('DISABLE_GUI'): - flask.abort(404) + return flask.redirect(flask.url_for( + 'static', filename='apidocs/index.html')) return flask.render_template('index.html', devices=manager.devices) @app.route('/api/1/devices/') def api_devices(): + """Lists all known devices. + + :status 200: list of all devices + :>json object [device_id]: listed device info object + """ + return flask.jsonify({k: v.dictify() for k, v in manager.devices.items()}) @app.route('/api/1/devices//') def api_device_info(node_id): + """Returns specified device info object. + + :param node_id: device ID or device name + :status 200: device found + :status 404: no device found + + :>json string $name: human-readable device name + :>json boolean $online: device is currently online + :>json object [endpoint_name]: endpoint object + :>json [endpoint_name].[prop_name]: last endpoint property value + """ node = manager.find_node(node_id) if not node: @@ -43,15 +61,33 @@ def api_device_info(node_id): return flask.jsonify(node.dictify()) -@app.route('/api/1/device////') +# @app.route('/api/1/device////') @app.route('/api/1/devices////') def device_write(node_id, endpoint, prop, value): + """Sets specified value to device endpoint and prop. + + :param node_id: device ID or device name + :param endpoint: endpoint name + :param prop: endpoint property name + :param value: value to set + :status 200: device found + :status 404: no device found + """ return flask.jsonify({ "result": manager.handle_request(node_id, endpoint, prop, value) }) @app.route('/api/1/devices///', methods=['PUT']) def device_put(node_id, endpoint, prop): + """Sets specified value to device endpoint and prop. + + :param node_id: device ID or device name + :param endpoint: endpoint name + :param prop: endpoint property name + :