rest框架api的模块化文档生成器
djangorestframework-apidoc的Python项目详细描述
django rest framework apidoc
==
library以改进django rest framework的文档系统。
<；=2.3.8，您需要对其进行修补。在第一次加载的模型模块中添加这一行。代码：：python
来自rest_-apidoc.monkey导入patch_-api_-view；patch_-api_-view（）
然后必须配置“rest_-framework”的“view_-description”函数
设置以使用rest_-apidoc版本：
。代码：：python
rest_framework={
…，
'查看描述函数'：'rest_framework_apidoc.apidoc.get_view_description'，
…，
}
，然后可以配置apidoc默认的文档器类：
。代码：：python
apidoc_default_documenter_classes=['rest_framework_apidoc.apidoc.mddocstringdocumenter']
apidoc_default_documenter_classes`默认值是`['rest_framework_apidoc.apidoc.mddocstringsdocumenter']`
如果使用基于文件的文档，您可以设置文档文件的路径：
代码：：Python
ApIDOCOA文档路径=“我的API文档”
BR/>“APIDOCCADIONTRONATORATION PATH”默认值为“APIDOC”
BR/> APIDoc Mixins
----BR/> BR/>文档者类由2种混合类型组成，内容混合
和过程MIXIN。内容混合获取文档文本，而BR/>过程混合在另一个事物中转换文本。
BR/>内容混合< BR/> ~~~~~~~~~~~~~~~~~~~Br/>< BR/> *FieleCon。MIXIN **：从一个名为URLLNEX+*BR/>扩展属性的文件中获取内容（如果存在），在
'APIDOCKOCEDATIONSORATION'中。
BR/>进程混合><~-~~~~~~~~~~~~~~~~~Br/>< BR/> *MARPUPPROCEPROMIXIN **：使用Django标记转换为HTML内容，基于BRU/>的标记类属性。< BR/**NoPuffixIn *>：不做任何事情。BR/***AuthPurialPixin in **：马克是安全的内容。
Documenter Classes > BR/> ----BR/>< BR> > RSTFilesDocumenter
> ~~~~~~~~~~~~~~~~~~~~~~~b/>由FieleCon和Mayin组成，MarkupProcessMixin用扩展=“.rST”和标记=RSTDocStringsDocumenter（Br/>）
＞~~~~~~~~~~~~~~~~~~~~~~~~（b/>），由DOCSTRIN CONTION COMIN和MarkupProcessMixin标记为“重构结构”BR/> BR/> MDFilesDocumenter
~~~~~~~~~~~~~~~~~~~~~
由FieleCon和Mixin组成。MDDocStringsDocumenter（Br/>）Br/>＞~~~~~~~~~~~~~~~~~~~~~~~（b/>），由DOCSTRIN CONTION COMIN和MarkupProcessMixin标记为“标记”Br/> Br/T>“纺织品”Br//> Br/Orth-OrthsReoprordPrimult
～~~~~~~~~~~~~~~~~~~~~~~~~
由DoStrink Cordon Mixin和MarkupProcessMixin标记为“纺织品”
Br/> TxtFilesDocumenter
~~~~~~~~~~~~~~~~~~~~b/>由FieleCon混合和NoPuffixIn组成。“TXT”＜Br/>＞TxtDocStringsDocumenter < Br>＞~~~~~~~~~~~~~~~~~~~~~~~~~~
由BrgEngutoMin组成的
< BR> > HtmlFilesDocumenter
～~~~~~~~~~~~~~~~~~~
。SuffCuffMIXIN与扩展名=“.html”
BR/> HtmlDocStringsDocumenter
~~~~~~~~~~~~~~~~~~~~~~~~
由DOCTRIN CONTION CONTIN COMIN和Suffice PROCESSIN组成
==
library以改进django rest framework的文档系统。
<；=2.3.8，您需要对其进行修补。在第一次加载的模型模块中添加这一行。代码：：python
来自rest_-apidoc.monkey导入patch_-api_-view；patch_-api_-view（）
然后必须配置“rest_-framework”的“view_-description”函数
设置以使用rest_-apidoc版本：
。代码：：python
rest_framework={
…，
'查看描述函数'：'rest_framework_apidoc.apidoc.get_view_description'，
…，
}
，然后可以配置apidoc默认的文档器类：
。代码：：python
apidoc_default_documenter_classes=['rest_framework_apidoc.apidoc.mddocstringdocumenter']
apidoc_default_documenter_classes`默认值是`['rest_framework_apidoc.apidoc.mddocstringsdocumenter']`
如果使用基于文件的文档，您可以设置文档文件的路径：
代码：：Python
ApIDOCOA文档路径=“我的API文档”
BR/>“APIDOCCADIONTRONATORATION PATH”默认值为“APIDOC”
BR/> APIDoc Mixins
----BR/> BR/>文档者类由2种混合类型组成，内容混合
和过程MIXIN。内容混合获取文档文本，而BR/>过程混合在另一个事物中转换文本。
BR/>内容混合< BR/> ~~~~~~~~~~~~~~~~~~~Br/>< BR/> *FieleCon。MIXIN **：从一个名为URLLNEX+*BR/>扩展属性的文件中获取内容（如果存在），在
'APIDOCKOCEDATIONSORATION'中。
BR/>进程混合><~-~~~~~~~~~~~~~~~~~Br/>< BR/> *MARPUPPROCEPROMIXIN **：使用Django标记转换为HTML内容，基于BRU/>的标记类属性。< BR/**NoPuffixIn *>：不做任何事情。BR/***AuthPurialPixin in **：马克是安全的内容。
Documenter Classes > BR/> ----BR/>< BR> > RSTFilesDocumenter
> ~~~~~~~~~~~~~~~~~~~~~~~b/>由FieleCon和Mayin组成，MarkupProcessMixin用扩展=“.rST”和标记=RSTDocStringsDocumenter（Br/>）
＞~~~~~~~~~~~~~~~~~~~~~~~~（b/>），由DOCSTRIN CONTION COMIN和MarkupProcessMixin标记为“重构结构”BR/> BR/> MDFilesDocumenter
~~~~~~~~~~~~~~~~~~~~~
由FieleCon和Mixin组成。MDDocStringsDocumenter（Br/>）Br/>＞~~~~~~~~~~~~~~~~~~~~~~~（b/>），由DOCSTRIN CONTION COMIN和MarkupProcessMixin标记为“标记”Br/> Br/T>“纺织品”Br//> Br/Orth-OrthsReoprordPrimult
～~~~~~~~~~~~~~~~~~~~~~~~~
由DoStrink Cordon Mixin和MarkupProcessMixin标记为“纺织品”
Br/> TxtFilesDocumenter
~~~~~~~~~~~~~~~~~~~~b/>由FieleCon混合和NoPuffixIn组成。“TXT”＜Br/>＞TxtDocStringsDocumenter < Br>＞~~~~~~~~~~~~~~~~~~~~~~~~~~
由BrgEngutoMin组成的
< BR> > HtmlFilesDocumenter
～~~~~~~~~~~~~~~~~~~
。SuffCuffMIXIN与扩展名=“.html”
BR/> HtmlDocStringsDocumenter
~~~~~~~~~~~~~~~~~~~~~~~~
由DOCTRIN CONTION CONTIN COMIN和Suffice PROCESSIN组成
欢迎加入QQ群-->： 979659372
