django-rest-swagger가 Markdown 문서 문자열을 HTML 코드로 구문 분석/변환하지 않습니다

Question

지금까지 django-rest-swagger은 v0.1.10의 Markdown 구문에서 docstring을 지원합니다. 그러나 문서를 보려고하면 구문 분석 대신 HTML 코드로 변환하는 대신 일반 텍스트로 표시됩니다.

내가 사용하고 있습니다 :

Django==1.5 
Markdown==2.3.1 
djangorestframework==2.3.10 
django-rest-swagger==0.1.11 

SWAGGER_SETTINGS = { 
    "exclude_namespaces": [], # List URL namespaces to ignore 
    "api_version": '0.1', # Specify your API's version 
    "api_path": "", # Specify the path to your API not a root level 
    "enabled_methods": [ # Specify which methods to enable in Swagger UI 
     'get', 
     'post', 
     'put', 
     'patch', 
     'delete' 
    ], 
    "api_key": '', # An API key 
    "is_authenticated": True, # Set to True to enforce user authentication, 
    "is_superuser": False, # Set to True to enforce admin only access 
} 

API 샘플 코드 기능 기반 뷰 :

이 API를 직접 탐색 할 때, 설명을 번역

@api_view(['POST']) 
def dummy(request): 
    ''' 
    Lorem ipsum `dolor` sit amet, consectetur adipiscing elit. Etiam sodales lacus at _nulla_ fringilla fringilla. 

    ### Consectetur adipiscing: 

     * __dummy_var__: Nunc ut erat justo. Duis turpis augue, posuere a ornare sed, 
     * another: Vestibulum suscipit congue neque sed faucibus. 
     * `code`: Cras sit amet ullamcorper ipsum. 
    ''' 
    pass 

/렌더링을 정확히.

오전 내가 모르는 뭔가가?

Answer 1

나는 당신이 아무것도 놓치고 있다고 생각하지 않습니다. Markdown은 DRF Browsable API보기에서만 사용됩니다. Swagger는 Markdown을 사용하지 않고 DRF가이를 사용하여 설명을 렌더링합니다.

스 내거는 아약스를 사용하여 설명 및 메모를 문자열로 전달합니다. 그런 다음 둘 다 html로 렌더링합니다. docs 문자열에 html 태그를 포함하여이를 확인할 수 있습니다. 그래서 Markdown 렌더러를 전혀 사용하지 않습니다.

DRF는 설명을 표시하기 위해 Markdown을 사용하므로 브라우저 API에서는 작동하지만 api-docs에서는 작동하지 않습니다.

Answer 2

버전 v0.2.0부터 markdown은 django-rest-swagger에서 사용할 수 있습니다!

단지 (이 자동으로 설치되지 않습니다) 명시 적으로 인하 패키지를 설치하는 데 필요한

:

pip install markdown