用coreapi记录api。
coreapidocs的Python项目详细描述
Coreapidocs[![特拉维斯][特拉维斯图片][特拉维斯网址][![pypi][pypi image]][pypi url]
====
使用coreapi记录api。
3.5)
-core-api([阅读更多](http://www.coreaapi.org/)
<35<35<35 <35 <35<<<
pip install core api docs
-coreapi-coreapidocs install coreapidoccs
``python
core api docs.docs导入文档
尝试:
schema=open(filename,'rb').read()
docs=docs(schema)
除了(ioerror,oserror):
中止(400,{“msg”:“没有这样的文件或目录-%s%filename})
`````
然后您可以简单地将“docs”变量传递给模板(即flask):
``python
return render_template('home.html',docs=docs.get_docs())
````
>有关详细信息,请查看[example.py](coreapidocs/example.py)的源代码。
参数ie.`document.json`.
然后转到:http://127.0.0.1:5000/
使用“jinja2”可以将“coreapidocs”模板传递到视图中。
``python
import sys
import jinja2
呈现模板
来自coreapidocs.docs导入文档
app=flask(u name_uu)
@app.route('/')
def docs():
“
生成coreapidocs并将其提供给roor。
接受一个带文件名的参数(即document.json)
”“
if len(sys argv)!=2:
中止(400,{“msg”:“缺少文件参数,即.document.json”})
尝试:
schema=open(filename,'rb').read()
docs=docs(schema)
除了(ioerror,oserror):
中止(400,{“msg”:“没有这样的文件或目录-%s%filename})
templates\loader=jinja2.packageloader('coreapidocs',“templates”)
template_env=jinja2.environment(loader=templates_loader)
template=template_env.get_Template('docs.html')
fixme:找出如何处理静态文件
返回呈现_Template(template,docs=docs.get_docs())
@app.route('/<;path:path>;
def static\u proxy(路径):
“
>服务静态文件。
“发送静态文件”将猜测正确的mime类型
“
>”
>返回app.send静态文件(路径)
>app.run()
``
测试
要运行测试,您必须运行:
python runtests.py
[travis image]:https://travis ci.org/ekonstanidis/coreapidocs.svg
[travis url]:https://travis ci.org/ekonstanidis/coreapidocs
[pypi image]:https://badge.fury.io/py/coreapidocs.svg
[pypi url]:https://pypi.python.org/pypi/coreapidocs/
====
使用coreapi记录api。
3.5)
-core-api([阅读更多](http://www.coreaapi.org/)
<35<35<35 <35 <35<<<
pip install core api docs
-coreapi-coreapidocs install coreapidoccs
``python
core api docs.docs导入文档
尝试:
schema=open(filename,'rb').read()
docs=docs(schema)
除了(ioerror,oserror):
中止(400,{“msg”:“没有这样的文件或目录-%s%filename})
`````
然后您可以简单地将“docs”变量传递给模板(即flask):
``python
return render_template('home.html',docs=docs.get_docs())
````
>有关详细信息,请查看[example.py](coreapidocs/example.py)的源代码。
参数ie.`document.json`.
使用“jinja2”可以将“coreapidocs”模板传递到视图中。
``python
import sys
import jinja2
呈现模板
来自coreapidocs.docs导入文档
app=flask(u name_uu)
@app.route('/')
def docs():
“
生成coreapidocs并将其提供给roor。
接受一个带文件名的参数(即document.json)
”“
if len(sys argv)!=2:
中止(400,{“msg”:“缺少文件参数,即.document.json”})
尝试:
schema=open(filename,'rb').read()
docs=docs(schema)
除了(ioerror,oserror):
中止(400,{“msg”:“没有这样的文件或目录-%s%filename})
templates\loader=jinja2.packageloader('coreapidocs',“templates”)
template_env=jinja2.environment(loader=templates_loader)
template=template_env.get_Template('docs.html')
fixme:找出如何处理静态文件
返回呈现_Template(template,docs=docs.get_docs())
@app.route('/<;path:path>;
def static\u proxy(路径):
“
>服务静态文件。
“发送静态文件”将猜测正确的mime类型
“
>”
>返回app.send静态文件(路径)
>app.run()
``
测试
要运行测试,您必须运行:
python runtests.py
[travis image]:https://travis ci.org/ekonstanidis/coreapidocs.svg
[travis url]:https://travis ci.org/ekonstanidis/coreapidocs
[pypi image]:https://badge.fury.io/py/coreapidocs.svg
[pypi url]:https://pypi.python.org/pypi/coreapidocs/