파이썬 docstrings에서 웹 API 문서를 생성하는 방법

Question

장고 웹 사이트가 있고 REST API를 만들었습니다. 뷰 함수에서는 REST URL에 대한 문서가 있고 REST URL에 대한 API 문서를 생성하려고합니다. 뷰 기능은 다음과 같이 :

def genres(request): 
    """ 
    Url: /api/genres/ 
    Parameters: None 
    Returns: list of genres { { "id":1, "name":"action" }, {...} } 
    """ 
    pass 

을하지만 myproject.api.views에 스핑크스를 실행할 때 나는 파이썬 API를 호출하기위한 HTML의 문서를 얻을. 스핑크스를 REST API처럼 문서화하도록 설정하는 방법이 있나요?

아니면 docstring에서 내 문서를 생성하는 스크립트를 작성하는 것이 더 좋습니까?

Answer 1

확인 sphinxcontrib-httpdomain

당신이 사용하기 위해 문서화 문자열과 httpdomain 확장을 사용하기 위해 autodoc을 사용할 수 있습니다 .. HTTP : 얻을 :/사용자/스타일의 지시. 이 솔루션에는 문제가 있으며 기능의 서명도 표시됩니다. 이 문제를 해결하기 위해 Sphinx 소스 코드를 약간 수정하여 서명을 최종 문서에 추가하지 않을 원래 autodoc 확장 사본을 만들었습니다.

파일

이 https://gist.github.com/4589457

지침에서 찾을 수 있습니다 :

1. 내 시스템에 gist (경로에 하나 스핑크스 경로에 application.py를 교체입니다/라이브러리/프레임 워크/Python.framework/버전/전류/lib 디렉토리/python2.7/사이트 패키지/스핑크스-1.1.3-py2.7.egg/스핑크스 /)
2. 는 내선 폴더에 simpleautodoc.py 추가
3. 는 HTTP .. 사용하기 위해서는 conf.py에 httpdomain 확장 추가 : :: 얻을/사용자/스타일의 지시
당신은 (접두사에게 autosimple 대신 자동차를 사용하여 autodoc를 사용 하듯이
4. 사용 simpleautodoc 예를 들어 autosimplemodule 대신 대신 AUTOCLASS 등의 automodule의 autosimpleclass)의
5. 는 example.py 파일은 우리가 sphinxcontrib를 사용하는 코드에서 별도의 문서를 보관해야 할 것 같은 내가