Web services without a proper documentation are usually useless.
To make it easy to document your own API, WSME provides a Sphinx extension.
Here we consider that you already quick-started a sphinx project.
In your conf.py file, add 'ext' to your extensions, and optionally set the enabled protocols.
extensions = ['ext']
wsme_protocols = ['restjson', 'restxml', 'extdirect']
Copy toggle.js and toggle.css in your _static directory.
The extension will add a new Sphinx domain providing a few directives.
A list of strings that are WSME protocol names. If provided by an additional package (for example WSME-Soap or WSME-ExtDirect), that package must be installed.
The types and services generated documentation will include code samples for each of these protocols.
A string that is the full name of the service root controller. It will be used to determinate the relative path of the other controllers when they are autodocumented, and calculate the complete webpath of the other controllers.
Define the service root controller for this documentation source file. To set it globally, see wsme_root.
A webpath option allows override of wsme_webpath.
Example:
.. wsme:root:: myapp.controllers.MyWSRoot
:webpath: /api
Declare a service.
Equivalent to the py:class directive to document a complex type
Equivalent to the py:attribute directive to document a complex type attribute. It takes an additional :type: field.
Source | Result |
---|---|
.. wsme:root:: wsmeext.sphinxext.SampleService
:webpath: /api
.. wsme:type:: MyType
.. wsme:attribute:: test
:type: int
.. wsme:service:: name/space/SampleService
.. wsme:function:: doit
|
Theses directives scan your code to generate the documentation from the docstrings and your API types and controllers.
Generate the myapp.MyType documentation.
Generate the myapp.MyType.aname documentation.
Generate the myapp.MyService documentation.
Generate the myapp.MyService.myfunction documentation.
class SampleType(object):
"""A Sample Type"""
#: A Int
aint = int
def __init__(self, aint=None):
if aint:
self.aint = aint
@classmethod
def sample(cls):
return cls(10)
class SampleService(wsme.WSRoot):
@wsme.expose(SampleType)
@wsme.validate(SampleType, int, str)
def change_aint(data, aint, dummy='useless'):
"""
:param aint: The new value
:return: The data object with its aint field value changed.
"""
data.aint = aint
return data
.. default-domain:: wsmeext
.. type:: int
An integer
.. autotype:: wsmeext.sphinxext.SampleType
:members:
.. autoservice:: wsmeext.sphinxext.SampleService
:members: