这个django应用程序从tastyperestapi生成孢子端点,并提供一个基于javascript的孢子客户端。

tastypie_spore_docs的Python项目详细描述


味觉孢子文件图片::https://img.shields.io/pypi/v/tastypie_spore_docs.svg
:目标:https://pypi.python.org/pypi/tastypie_spore_docs/
:alt:最新版本

。图片::https://img.shields.io/pypi/dm/tastypie_spore_docs.svg
:目标:https://pypi.python.org/pypi/tastypie_spore_docs/
:alt:downloads

。图片::https://img.shields.io/pypi/pyversions/tastypie_spore_docs.svg
:目标:https://pypi.python.org/pypi/tastypie_spore_docs/
:alt:支持的python版本

。图片::https://img.shields.io/pypi/status/tastypie_spore_docs.svg
:目标:https://pypi.python.org/pypi/tastypie_spore_docs/
:alt:开发状态

。图片::https://img.shields.io/pypi/l/tastypice_spore_docs.svg
:目标:https://pypi.python.org/pypi/tastypice_spore_docs/
:alt:license



这是剑桥EMBL-EBI Chembl Group开发的tastypice_spore_docs包,英国。

此软件包作为孢子客户端从Tastypie Rest端点生成实时在线文档。

基本原理?
--

`.
您可能希望鼓励一些开发人员使用它。
但是如何在没有文档的情况下使用它呢?
文档很重要,但编写起来也很枯燥。
由于人们会在线阅读文档,因此他们也可以从浏览器中执行rest api。



此库可以解决您的所有问题-它可以为您生成实时的在线文档。
它可以检查您的tastypie api,获取所有可用的方法并生成一个很好的联机文档,每个人都可以在其中尝试。
它通过生成一个“spore<;https://github.com/spore/specifications>;`\br/>端点和提供基于javascript的客户端来实现这一点,该客户端使用
端点并呈现文档。

对于每个django应用程序,首先要做的是将其添加到“已安装的应用程序”列表中。::


必须在“settings.py”中包含一个必需的参数。
它名为“tastypice-doc-api”,应该是一个字符串,其中包含指向tastypice-api实例的虚线路径。:


tastypice-doc-api='path.to.rest.api'

文档页上的标题。:

tastypice_doc_name='我的全新文档'


此应用程序提供URL配置,因此您需要将其包含在“url.py”中才能看到。


自定义方法所需的参数和说明
--

参数或需要一些自定义描述。
您可以通过将“Required\u params”和“Descriptions”词典添加到您的Tastype资源“meta”类中来自定义此项。
对于这两个词典,键应该是方法名(例如“api-get-u-detail`)”。
该值是“required-params”的参数名(字符串)列表和“descriptions”的描述字符串。



创建一个孢子客户端,并应进行修改。
``head_banner.html``将自定义内容添加到文档的“收件人”,并应进行扩展/覆盖。

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java从Struts操作的钩子更改表单值(Liferay 6.2)   java如何改变Spring MVC处理url“点”字符的行为   Clojure中使用Java接口的问题   junit如何模拟comosDB azure java集成客户端?   运行函数时发生java错误   netbeans Java。jar文件和依赖项   Eclipse中文本字段中的java输入类型   在JAVA中,将集合变量从实时批处理运行时传递到调用批处理文件   java通过Bean验证API中的自定义消息管理异常   XML到json的转换,在Java中,同时保留数据类型   根据JAVA中的列名从Excel文件中获取单元格值   在AsyncTask的doInBackground中未调用java FirebaseMessagingService   java如何在数据库中插入一行?