6-1 如何生成API接口文档

6-1 如何生成API接口文档

访问：

http://localhost:8000/course/cbv/list/

C:\Users\Administrator\PycharmProjects\drf_tutorial\drf_tutorial\drf_tutorial\settings.py

 

设置路由

报错：

"D:\Program Files\JetBrains\PyCharm 2017.1.3\bin\runnerw.exe" C:\Users\Administrator\Envs\chongkong_vir\Scripts\python.exe "D:\Program Files\JetBrains\PyCharm 2017.1.3\helpers\pydev\pydevd.py" --multiproc --qt-support --client 127.0.0.1 --port 51862 --file C:/Users/Administrator/PycharmProjects/drf_tutorial/drf_tutorial/manage.py runserver 8000
warning: Debugger speedups using cython not found. Run '"C:\Users\Administrator\Envs\chongkong_vir\Scripts\python.exe" "D:\Program Files\JetBrains\PyCharm 2017.1.3\helpers\pydev\setup_cython.py" build_ext --inplace' to build.
pydev debugger: process 7728 is connecting

Connected to pydev debugger (build 171.4424.42)
warning: Debugger speedups using cython not found. Run '"C:\Users\Administrator\Envs\chongkong_vir\Scripts\python.exe" "D:\Program Files\JetBrains\PyCharm 2017.1.3\helpers\pydev\setup_cython.py" build_ext --inplace' to build.
pydev debugger: process 9780 is connecting

Performing system checks...

Unhandled exception in thread started by <_pydev_bundle.pydev_monkey._NewThreadStartupWithTrace object at 0x000001CA4415FA20>
Traceback (most recent call last):
  File "D:\Program Files\JetBrains\PyCharm 2017.1.3\helpers\pydev\_pydev_bundle\pydev_monkey.py", line 589, in __call__
    return self.original_func(*self.args, **self.kwargs)
  File "C:\Users\Administrator\Envs\chongkong_vir\lib\site-packages\django\utils\autoreload.py", line 225, in wrapper
    fn(*args, **kwargs)
  File "C:\Users\Administrator\Envs\chongkong_vir\lib\site-packages\django\core\management\commands\runserver.py", line 120, in inner_run
    self.check(display_num_errors=True)
  File "C:\Users\Administrator\Envs\chongkong_vir\lib\site-packages\django\core\management\base.py", line 364, in check
    include_deployment_checks=include_deployment_checks,
  File "C:\Users\Administrator\Envs\chongkong_vir\lib\site-packages\django\core\management\base.py", line 351, in _run_checks
    return checks.run_checks(**kwargs)
  File "C:\Users\Administrator\Envs\chongkong_vir\lib\site-packages\django\core\checks\registry.py", line 73, in run_checks
    new_errors = check(app_configs=app_configs)
  File "C:\Users\Administrator\Envs\chongkong_vir\lib\site-packages\django\core\checks\urls.py", line 13, in check_url_config
    return check_resolver(resolver)
  File "C:\Users\Administrator\Envs\chongkong_vir\lib\site-packages\django\core\checks\urls.py", line 23, in check_resolver
    return check_method()
  File "C:\Users\Administrator\Envs\chongkong_vir\lib\site-packages\django\urls\resolvers.py", line 397, in check
    for pattern in self.url_patterns:
  File "C:\Users\Administrator\Envs\chongkong_vir\lib\site-packages\django\utils\functional.py", line 36, in __get__
    res = instance.__dict__[self.name] = self.func(instance)
  File "C:\Users\Administrator\Envs\chongkong_vir\lib\site-packages\django\urls\resolvers.py", line 536, in url_patterns
    patterns = getattr(self.urlconf_module, "urlpatterns", self.urlconf_module)
  File "C:\Users\Administrator\Envs\chongkong_vir\lib\site-packages\django\utils\functional.py", line 36, in __get__
    res = instance.__dict__[self.name] = self.func(instance)
  File "C:\Users\Administrator\Envs\chongkong_vir\lib\site-packages\django\urls\resolvers.py", line 529, in urlconf_module
    return import_module(self.urlconf_name)
  File "c:\users\administrator\appdata\local\programs\python\python35\lib\importlib\__init__.py", line 126, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
  File "<frozen importlib._bootstrap>", line 986, in _gcd_import
  File "<frozen importlib._bootstrap>", line 969, in _find_and_load
  File "<frozen importlib._bootstrap>", line 958, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 673, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 673, in exec_module
  File "<frozen importlib._bootstrap>", line 222, in _call_with_frames_removed
  File "C:/Users/Administrator/PycharmProjects/drf_tutorial/drf_tutorial\drf_tutorial\urls.py", line 21, in <module>
    schema_view = get_schema_view(title="DRF API文档", description="XXX---")
  File "C:\Users\Administrator\Envs\chongkong_vir\lib\site-packages\rest_framework\schemas\__init__.py", line 47, in get_schema_view
    urlconf=urlconf, patterns=patterns, version=version
  File "C:\Users\Administrator\Envs\chongkong_vir\lib\site-packages\rest_framework\schemas\coreapi.py", line 120, in __init__
    assert coreapi, '`coreapi` must be installed for schema support.'
AssertionError: `coreapi` must be installed for schema support.

解决办法：

pip install coreapi==2.0.8

pip install coreschema

 

启动又报错：

"D:\Program Files\JetBrains\PyCharm 2017.1.3\bin\runnerw.exe" C:\Users\Administrator\Envs\chongkong_vir\Scripts\python.exe "D:\Program Files\JetBrains\PyCharm 2017.1.3\helpers\pydev\pydevd.py" --multiproc --qt-support --client 127.0.0.1 --port 52436 --file C:/Users/Administrator/PycharmProjects/drf_tutorial/drf_tutorial/manage.py runserver 8000
warning: Debugger speedups using cython not found. Run '"C:\Users\Administrator\Envs\chongkong_vir\Scripts\python.exe" "D:\Program Files\JetBrains\PyCharm 2017.1.3\helpers\pydev\setup_cython.py" build_ext --inplace' to build.
pydev debugger: process 9460 is connecting

Connected to pydev debugger (build 171.4424.42)
warning: Debugger speedups using cython not found. Run '"C:\Users\Administrator\Envs\chongkong_vir\Scripts\python.exe" "D:\Program Files\JetBrains\PyCharm 2017.1.3\helpers\pydev\setup_cython.py" build_ext --inplace' to build.
pydev debugger: process 2024 is connecting

Performing system checks...

Unhandled exception in thread started by <_pydev_bundle.pydev_monkey._NewThreadStartupWithTrace object at 0x00000131C3893E48>
Traceback (most recent call last):
  File "D:\Program Files\JetBrains\PyCharm 2017.1.3\helpers\pydev\_pydev_bundle\pydev_monkey.py", line 589, in __call__
    return self.original_func(*self.args, **self.kwargs)
  File "C:\Users\Administrator\Envs\chongkong_vir\lib\site-packages\django\utils\autoreload.py", line 225, in wrapper
    fn(*args, **kwargs)
  File "C:\Users\Administrator\Envs\chongkong_vir\lib\site-packages\django\core\management\commands\runserver.py", line 120, in inner_run
    self.check(display_num_errors=True)
  File "C:\Users\Administrator\Envs\chongkong_vir\lib\site-packages\django\core\management\base.py", line 364, in check
    include_deployment_checks=include_deployment_checks,
  File "C:\Users\Administrator\Envs\chongkong_vir\lib\site-packages\django\core\management\base.py", line 351, in _run_checks
    return checks.run_checks(**kwargs)
  File "C:\Users\Administrator\Envs\chongkong_vir\lib\site-packages\django\core\checks\registry.py", line 73, in run_checks
    new_errors = check(app_configs=app_configs)
  File "C:\Users\Administrator\Envs\chongkong_vir\lib\site-packages\django\core\checks\urls.py", line 13, in check_url_config
    return check_resolver(resolver)
  File "C:\Users\Administrator\Envs\chongkong_vir\lib\site-packages\django\core\checks\urls.py", line 23, in check_resolver
    return check_method()
  File "C:\Users\Administrator\Envs\chongkong_vir\lib\site-packages\django\urls\resolvers.py", line 397, in check
    for pattern in self.url_patterns:
  File "C:\Users\Administrator\Envs\chongkong_vir\lib\site-packages\django\utils\functional.py", line 36, in __get__
    res = instance.__dict__[self.name] = self.func(instance)
  File "C:\Users\Administrator\Envs\chongkong_vir\lib\site-packages\django\urls\resolvers.py", line 536, in url_patterns
    patterns = getattr(self.urlconf_module, "urlpatterns", self.urlconf_module)
  File "C:\Users\Administrator\Envs\chongkong_vir\lib\site-packages\django\utils\functional.py", line 36, in __get__
    res = instance.__dict__[self.name] = self.func(instance)
  File "C:\Users\Administrator\Envs\chongkong_vir\lib\site-packages\django\urls\resolvers.py", line 529, in urlconf_module
    return import_module(self.urlconf_name)
  File "c:\users\administrator\appdata\local\programs\python\python35\lib\importlib\__init__.py", line 126, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
  File "<frozen importlib._bootstrap>", line 986, in _gcd_import
  File "<frozen importlib._bootstrap>", line 969, in _find_and_load
  File "<frozen importlib._bootstrap>", line 958, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 673, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 673, in exec_module
  File "<frozen importlib._bootstrap>", line 222, in _call_with_frames_removed
  File "C:/Users/Administrator/PycharmProjects/drf_tutorial/drf_tutorial\drf_tutorial\urls.py", line 18, in <module>
    from rest_framework.authtoken import views
  File "C:\Users\Administrator\Envs\chongkong_vir\lib\site-packages\rest_framework\authtoken\views.py", line 10, in <module>
    class ObtainAuthToken(APIView):
  File "C:\Users\Administrator\Envs\chongkong_vir\lib\site-packages\rest_framework\authtoken\views.py", line 25, in ObtainAuthToken
    description="Valid username for authentication",
TypeError: __new__() got an unexpected keyword argument 'schema'

 

pip install -i https://pypi.doubanio.com/simple/ django-rest-swagger

pip install -i https://pypi.doubanio.com/simple/ django-filter

 

访问：

http://localhost:8000/schema/