Metadata-Version: 1.1
Name: drf-swagger-customization
Version: 0.1.2
Summary: This is a django app which you can modify and improve your autogenerated swagger documentation from your drf API.
Home-page: https://github.com/androiz/drf-swagger-customization
Author: Andres Rojano Ruiz
Author-email: androiz10@gmail.com
License: MIT
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://travis-ci.org/androiz/drf-swagger-customization.svg?branch=master
            :target: https://travis-ci.org/androiz/drf-swagger-customization
        
        .. image:: https://codecov.io/gh/androiz/drf-swagger-customization/branch/master/graph/badge.svg
            :target: https://codecov.io/gh/androiz/drf-swagger-customization
        
        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/update/remove information to our EXTENSION_PATH json file,  we have available these operations:
        
        Create:
        ~~~~~~~~~~~~~~~~~~~~~~
        
        .. code-block:: json
        {
            "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:: json
        {
            "operation": "update",
            "swagger-data": {
                "paths|/v1/travels/|get|parameters|field1": {
                    "name": "Field1",
                    "in": "query",
                    "required": true,
                    "type": "string"
                }
            }
        }
        
        Remove:
        ~~~~~~~~~~~~~~~~~~~~~~
        
        .. code-block:: json
        {
            "operation": "delete",
            "swagger-data": "paths|/v1/travels/|get|parameters|field1"
        }
        
        Completed Sample
        --------
        
        .. code-block:: json
        [
          {
            "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"
          }
        ]
        
        Future Work
        --------
        
        * Add an example
        * Command for doc_file customization, in order to remove redundant executions.
        * Improve the settings options.
        
        
        
        
        History
        -------
        
        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.
        
Keywords: drf-swagger-customization
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.8
Classifier: Framework :: Django :: 1.9
Classifier: Framework :: Django :: 1.10
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
