Skip to content

Commit

Permalink
2020.3.28 v1.2 的多种修改,删除旧代码,单元重新归类,单元测试调整,基本完成;
Browse files Browse the repository at this point in the history
  • Loading branch information
wingfish committed Mar 28, 2020
1 parent fe76018 commit 5ad44b9
Show file tree
Hide file tree
Showing 7 changed files with 548 additions and 512 deletions.
78 changes: 49 additions & 29 deletions README.rst
Expand Up @@ -12,7 +12,9 @@
fishbase 简介
=================

fishbase 是由我们自主开发和整理的一套 Python 基础函数库,当前版本为 v1.1.16.
fishbase 是由我们自主开发和整理的一套 Python 基础函数库,将我们平时在开发 Python 项目时候的各类工具函数汇聚到一起,方便集中管理和使用。

fishbase 当前版本为 v1.2,支持 Python 3.5-3.8,绝大部分函数也能工作在 Python 2.7 下,但是我们不推荐使用 Python 2.7 .

自 2016/3 初次发布以来,我们坚持不断更新,先后发布了 20 余个版本。近一年来,我们逐步形成每月更新 1 到 2 个版本的频率,抽象出了很多通用的方法,主要分为以下模块:

Expand Down Expand Up @@ -55,34 +57,7 @@ fishbase 是由我们自主开发和整理的一套 Python 基础函数库,当
fishbase 能干什么?
===================


集成 swagger 为 flask 应用生成接口文档信息
-----------------------------------------------

.. code:: python
>>> from fishbase.swagger import doc
>>> from fishbase.swagger.swagger import flask_swagger
>>> from flask import Flask
>>> # 创建 Flask app
>>> app = Flask("Demo Server")
>>> @app.route('/v1/query', methods=['GET'])
>>> @doc.summary("xx业务查询接口", group="xx业务")
>>> @doc.description("测试 Swagger 使用, 参数为 URL 参数 token, 且必传")
>>> @doc.consumes("token", required=True)
>>> def test_query():
>>> pass
>>> # 将 app 对象传递给 swagger 模块
>>> flask_swagger(app)
>>> if __name__ == "__main__":
>>> app.run("127.0.0.1", "8899", debug=False)
访问: http://127.0.0.1:8899/swagger/ 即可查看接口信息,并在线调试。更多 swagger 使用技巧,可参考 https://fishbase.readthedocs.io/en/latest/swagger.html

举例:

获取文件的绝对路径
------------------------------
Expand Down Expand Up @@ -139,6 +114,34 @@ fishbase 能干什么?
['requirements.txt', 'README.md', 'setup.py']
集成 swagger 为 flask 应用生成接口文档信息
-----------------------------------------------

.. code:: python
>>> from fishbase.swagger import doc
>>> from fishbase.swagger.swagger import flask_swagger
>>> from flask import Flask
>>> # 创建 Flask app
>>> app = Flask("Demo Server")
>>> @app.route('/v1/query', methods=['GET'])
>>> @doc.summary("xx业务查询接口", group="xx业务")
>>> @doc.description("测试 Swagger 使用, 参数为 URL 参数 token, 且必传")
>>> @doc.consumes("token", required=True)
>>> def test_query():
>>> pass
>>> # 将 app 对象传递给 swagger 模块
>>> flask_swagger(app)
>>> if __name__ == "__main__":
>>> app.run("127.0.0.1", "8899", debug=False)
访问: http://127.0.0.1:8899/swagger/ 即可查看接口信息,并在线调试。更多 swagger 使用技巧,可参考 https://fishbase.readthedocs.io/en/latest/swagger.html


最近更新
==========
2019.12.5 v1.1.16
Expand Down Expand Up @@ -168,3 +171,20 @@ fishbase 能干什么?
更多详细文档,请参见:http://fishbase.readthedocs.io/

如有好的建议,欢迎提 issue :https://github.com/chinapnr/fishbase/issues


感谢
====

非常感谢所有在 fishbase 函数包发展过程中做出共享的朋友们:

Leo
Zhang Muqing
Hu Jun
Jia Chunyin
Yan Runsha
Miao Tianshi
Jin Xiongwei
Yi Jun


0 comments on commit 5ad44b9

Please sign in to comment.