Databases
StackOverflow2013
Postsdbo
POAutomatically document my REST API
 

Note that there are some explanatory texts on larger screens.

plurals
  1. POAutomatically document my REST API
    primarykey
    data
    text
    <p>I am trying to create documentation automatically from the code for all the URLs supported by my application. We are using completely client side MVC, hence each URL that is supported is essentially a REST API for the UI. Is there a easy way to generate the documentation from these URLs?</p> <p>I wrote this small module as of now, but I am looking for better ways then this. I don't want to re-invent the wheel if something similar already exists. </p> <p><strong>UPDATE</strong>: Note the intent is to provide a public documentation for the consumers of the website, not for internal consumption. In this regard, for each URL we need to document: - what is the response, - which parameters are accepted, - if the URL responds to GET/POST or both, etc. </p> <p>Certain URLs like (^$) that simply redirect to home page should not be documented, so I will need some exclusion mechanism as well. </p> <pre><code>from django.core.management.base import BaseCommand from django.conf import settings class Command(BaseCommand): ''' Generates documentation for the URLs. For each URL includes the documentation from the callback implementing the URL and prints the default arguments along with the URL pattern and name''' def handle(self, *args, **options): url_module = None exec 'import '+settings.ROOT_URLCONF+'; url_module='+settings.ROOT_URLCONF doc = file('doc.html','w') doc.write("&lt;table border=1 cellspacing=0 cellpadding=5&gt;") doc.write("&lt;tr&gt;&lt;th&gt;URL Pattern&lt;th&gt;Name&lt;th&gt;Documentation&lt;th&gt;Parameters") for x in url_module.urlpatterns: doc.write("&lt;tr&gt;") doc.write("&lt;td&gt;") doc.write(x._regex) doc.write("&lt;td&gt;") doc.write(str(x.name)) try: documentation = str(x.callback.__doc__) doc.write("&lt;td&gt;&lt;pre&gt;") doc.write(documentation) doc.write("&lt;/pre&gt;") except: doc.write("&lt;td&gt; Unable to find module") doc.write("&lt;td&gt;") doc.write(str(x.default_args)) doc.write("&lt;/table&gt;") doc.close() </code></pre>
    singulars
    1. PO
      singulars
      1. PTAnswer
    1. This table or related slice is empty.
    1. PTQuestion
    1. USBryanH
    1. USEswar Vandanapu
    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. PO
      singulars
      1. PTAnswer
    2. PO
      singulars
      1. PTAnswer
    1. VO
      singulars
      1. POAutomatically document my REST API
      1. This table or related slice is empty.
      1. VTUpMod
    2. VO
      singulars
      1. POAutomatically document my REST API
      1. This table or related slice is empty.
      1. VTUpMod
    3. VO
      singulars
      1. POAutomatically document my REST API
      1. This table or related slice is empty.
      1. VTUpMod
    1. COhttp://task3.cc/53/document-your-django-project-using-sphinx-documentation-tool-and-restructuredtext/, you could add full project documentation to your url documentation
      singulars
      1. POAutomatically document my REST API
      1. USdm03514
    2. COOfcourse. However the intent here is to create documentation, we can publish for all external consumers of our website. For that goal, I would rather not publish the documentation of all our code.
      singulars
      1. POAutomatically document my REST API
      1. USEswar Vandanapu
 

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