Databases
StackOverflow2013
Postsdbo
PO
 

Note that there are some explanatory texts on larger screens.

plurals
  1. PO
    primarykey
    data
    text
    <p>Since there doesn't appear to be any existing solution, I have implemented a very simple HTTP domain that I can use to mark up API methods:</p> <pre><code>import re from docutils import nodes from sphinx import addnodes from sphinx.locale import l_, _ from sphinx.domains import Domain, ObjType from sphinx.directives import ObjectDescription http_method_sig_re = re.compile(r'^(GET|POST|PUT|DELETE)?\s?(\S+)(.*)$') class HTTPMethod(ObjectDescription): def handle_signature(self, sig, signode): m = http_method_sig_re.match(sig) if m is None: raise ValueError verb, url, query = m.groups() if verb is None: verb = 'GET' signode += addnodes.desc_addname(verb, verb) signode += addnodes.desc_name(url, url) if query: params = query.strip().split() for param in params: signode += addnodes.desc_optional(param, param) return url class HTTPDomain(Domain): """HTTP language domain.""" name = 'http' label = 'HTTP' object_types = { 'method': ObjType(l_('method'), 'method') } directives = { 'method': HTTPMethod } def setup(app): app.add_domain(HTTPDomain) </code></pre> <p>It allows me to mark up methods like this and they'll be styled somewhat visually nicely:</p> <pre><code>.. http:method:: GET /api/foo/bar/:id/:slug :param id: An id :param slug: A slug Retrieve list of foobars matching given id. </code></pre> <p>This was my first foray into both Sphinx and Python, so this should be considered very rudimentary code. If anybody is interested in fleshing this out, please <a href="https://github.com/deceze/Sphinx-HTTP-domain" rel="noreferrer">fork this project on Github</a>!</p>
    singulars
    1. This table or related slice is empty.
    1. PORESTful web service API documentation with Sphinx
      singulars
      1. PTQuestion
    1. PTAnswer
    1. USdeceze
    1. USdeceze
    plurals
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. VO
      singulars
      1. PO
      1. This table or related slice is empty.
      1. VTUpMod
    2. VO
      singulars
      1. PO
      1. This table or related slice is empty.
      1. VTUpMod
    3. VO
      singulars
      1. PO
      1. This table or related slice is empty.
      1. VTUpMod
    1. COgreat! thanks! you should add the term Restful to the title to get a higher google pagerank on this topic :) I could do it, but I don't like messing with good questions.
      singulars
      1. PO
      1. USHenrik P. Hessel
    2. CO@Henrik Good point. :) I'm thinking about throwing this up on Github to allow for some collaborative development. What do you think?
      singulars
      1. PO
      1. USdeceze
    3. COWouldn't harm anyone if its over on the Githubs ;)
      singulars
      1. PO
      1. USHenrik P. Hessel
 

Querying!

 
Guidance
A row detail

Detail views are divided into sections. All the information in the data section comes from columns in the selected row. The other sections display data from other, related rows.

Related data can be related in a to-one or a to-many fashion. Captions of data related in a to-many fashion link to a list view showing a filtered view of the table.

Try moving around until you find a non-empty to-many entry and click on the label to get to one. You can move back to the root by clicking on the database name in the header.

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload