Skip to main content

This is a django app which you can modify and improve your autogenerated swagger documentation from your drf API.

Project description

=============================
drf-swagger-customization
=============================

.. image:: https://badge.fury.io/py/drf-swagger-customization.svg
:target: https://badge.fury.io/py/drf-swagger-customization

.. image:: https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat
:target: http://drf-swagger-customization.readthedocs.io/en/latest/

This is a django app which you can modify and improve your autogenerated swagger documentation from your drf API.

Documentation
-------------

The full documentation is at https://drf-swagger-customization.readthedocs.io.

Quickstart
----------

Install drf-swagger-customization::

pip install drf-swagger-customization


Add these global variables to your settings.py:

.. code-block:: python

EXTENSION_PATH = os.path.join(PROJECT_DIR, 'docs/doc_extension.json') # Path to your extension file
EXTERNAL_DOC_FOLDER = os.path.join(PROJECT_DIR, 'docs/external/') # Path to your external documentation folder


Add drf-swagger-customization's URL patterns:

.. code-block:: python

from drf_swagger_customization.views import get_swagger_view

schema_view = get_swagger_view(title='Pastebin API')

urlpatterns = [
...
url(r'^docs/$', schema_view),
...
]

Usage
--------
With this package we can increase the auto-generated documentation from django-swagger. That way, we can add documentation
from external APIs or add more information to our drf API methods such as fields, remove endpoints, update attributes, and so on.

In order to add information to our EXTENSION_PATH json file, we have available these operations:

Create
~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: javascript

{
"operation": "create",
"swagger-data": {
"paths|/v1/travels/|get|parameters": [
{
"name": "Field1",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "Field2",
"in": "path",
"required": true,
"type": "integer"
}
]
}
}

Update
~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: javascript

{
"operation": "update",
"swagger-data": {
"paths|/v1/travels/|get|parameters|field1": {
"name": "Field1",
"in": "query",
"required": true,
"type": "string"
}
}
}


Remove
~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: javascript

{
"operation": "delete",
"swagger-data": "paths|/v1/travels/|get|parameters|field1"
}

Rename
~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: javascript

{
"action": "rename",
"operation": {
"paths|/v1/travels/": "/travels/",
"paths|/v1/travels/{id}/": "/travels/{id}/"
}
}


Completed Sample
--------

.. code-block:: javascript

[
{
"operation": "create",
"swagger-data": {
"paths|/v1/travels/|get|parameters": [
{
"name": "Field1",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "Field2",
"in": "path",
"required": true,
"type": "integer"
}
]
}
},
{
"operation": "update",
"swagger-data": {
"paths|/v1/travels/|get|parameters|field1": {
"name": "Field1",
"in": "query",
"required": true,
"type": "string"
}
}
},
{
"operation": "delete",
"swagger-data": "paths|/v1/travels/|get|parameters|field1"
},
{
"action": "rename",
"operation": {
"paths|/v1/travels/": "/travels/",
"paths|/v1/travels/{id}/": "/travels/{id}/"
}
}
]


Future Work
--------

* Add an example
* Command for doc_file customization, in order to remove redundant executions.
* Improve the settings options.




History
-------

0.1.5 (2017-05-31)
++++++++++++++++++

* Added new action "Rename"

0.1.4 (2017-05-30)
++++++++++++++++++

* Bugfix with documentation

0.1.3 (2017-05-30)
++++++++++++++++++

* Bugfix with documentation

0.1.2 (2017-05-30)
++++++++++++++++++

* Improved documentation in order to explain how to build the json file

0.1.1 (2017-05-25)
++++++++++++++++++

* Fix in methods add, update and remove documentation.

0.1.0 (2017-05-24)
++++++++++++++++++

* First release on PyPI.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

drf-swagger-customization-0.1.5.tar.gz (8.6 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page