Bug#736913: ITP: django-rest-swagger -- API documentation generator for Swagger UI and Django REST Framework
Package: wnpp
Severity: wishlist
Owner: Benjamin Drung <benjamin.drung@profitbricks.com>
* Package name : django-rest-swagger (binary: python-rest-framework-swagger)
Version : 0.1.11
Upstream Author : Marc Gibbons <marc_gibbons@rogers.com>
* URL : https://github.com/marcgibbons/django-rest-swagger
* License : BSD-2-clause (MIT, BSD-3-Clause, GPL-2 for the libraries)
Programming Lang: Python
Description : API documentation generator for Swagger UI and Django REST Framework
This project provides an API documentation generator and is built on the Django
REST Framework Docs and uses the lovely Swagger from Wordnik as an interface.
This application introspectively generates documentation based on your Django
REST Framework API code. Comments are generated in combination from code
analysis and comment extraction. Here are some of the features that are
documented:
.
* API title - taken from the class name
* Methods allowed
* Serializers & fields in use by a certain method
* Field default values, minimum, maximum, read-only and required attributes
* URL parameters (ie. /product/{id})
* Field help_text property is used to create the description from the
serializer or model.
* Query parameters (user-defined) - Custom parameters. It is possible to
customize a parameter list for your API. To do so, include a key-value pair
in the docstring of your API class delimited by two hyphens ('--').
Example: 'start_time -- The first reading'
The package ships some javascript libraries in
rest_framework_swagger/static/rest_framework_swagger/lib (some of them
minified). What is the recommended way to handle these? Do I have to package
every javascript library separately? Should I just replace the javascript
libraries by symlinks to the system libraries and remove the symlinks in the
clean target? Should I repack the source tarball (to get rid of the minified
files) or is it enough to just not use these files?
This package needs jquery >= 1.8 and uses following javascript libraries that
are not packaged yet: handlebars, jquery.ba-bbq, jquery.slideto, jquery.wiggle,
and shred.
Reply to: