andpp/mopidy
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

http: Improve Router docstrings, include in API docs

Browse Source
This commit is contained in:
Stein Magnus Jodal 2014-05-14 23:42:55 +02:00
parent 05f23e1108
commit 83bb891de4
2 changed files with 24 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/api/http.rst
View File

@ -4,6 +4,9 @@
HTTP API
********
.. module:: mopidy.http
:synopsis: The HTTP frontend APIs
The :ref:`ext-http` extension makes Mopidy's :ref:`core-api` available over
HTTP using WebSockets. We also provide a JavaScript wrapper, called
:ref:`Mopidy.js <mopidy-js>` around the HTTP API for use both from browsers and
@ -22,6 +25,16 @@ Node.js.
stable.
Server side API
===============
TODO: Describe how this is used. Consider splitting this page into multiple
pages.
.. autoclass:: mopidy.http.Router
:members:
.. _websocket-api:
WebSocket API

24
mopidy/http/__init__.py
View File

@ -53,11 +53,11 @@ class Router(object):
"""
HTTP router interface.
Extensions that wish to add custom routes to HTTP server
need to sub-class this class and install and configure it with an
extension.
Extensions that wish to add custom routes to HTTP server needs to subclass
this class and have :meth:`~mopidy.ext.Extension.setup` register the class
in the extension registry.
:param config:dict Config dictionary
:param config: dict structure of the entire Mopidy configuration
"""
#: Name of the HTTP router implementation, must be overridden.
@ -77,29 +77,27 @@ class Router(object):
"""
Absolute URL to the root of this router.
:return string: URI
:return: URL this router is mounted at
"""
return 'http://%s:%s/%s/' % (self.hostname, self.port, self.name)
def setup_routes(self):
"""
Configure routes for this interface
Configure routes for this interface.
Implementation must return list of routes, compatible with
:`class:tornado.web.Application`.
:class:`tornado.web.Application`.
:return list: List of tornado routes
:return: list of Tornado routes
"""
if not self.path:
if self.path is None:
raise ValueError('Undefined path in %s' % self)
logger.info(
'Serving HTTP extension %s at %s' %
(type(self), self.linkify())
)
'Serving HTTP extension %s at %s', type(self), self.linkify())
return [
(r'/%s/(.*)' % self.name, StaticFileHandler, {
'path': self.path,
'default_filename': 'index.html'
})
}),
]