Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

enhance apistar web framework.

Project description

apistellar WEB框架

Badge

GitHub

GitHub followers GitHub repo size in bytes GitHub stars GitHub release Github commits (since latest release)

Github All Releases GitHub Release Date

PyPi

PyPI PyPI - Wheel PyPI - Python Version PyPI - Format PyPI - Implementation PyPI - Status

Desc

apistellar是基于apistar的web构建工具,同时增强了apistar的功能,使用apistellar可以轻松构建适合生产环境的web项目。

apistellar部分设计灵感参考ruby on rails

除了apistar本身的特性以外,apistellar增加如下几点高级用法:

  1. CSM架构,将控制层,业务层,模型层完全分离,耦合性降至最低。
  2. 模板式定制各类模型,轻松扩展模型定义的模板类。
  3. 适配sphinx注释语法,使用构建命令一键生成api文档和RPC-client。
  4. 集成flask版的session实现。
  5. 自带一些event hook,轻松集成异常、session处理。
  6. 集成配置模块,集中管理所有配置信息。
  7. 离线任务管理,同一web服务下的离线任务,轻松复用web模块定义的model, service等等可注入对象。模板一键创建。
  8. 集成IPython交互式命令行工具,自动注入model, service等对象。提供异步代码执行能力,轻松调试各模块。
  9. 提供上传文件流对象,对大文件上传完美支持。
  10. Apistar作者在uvicorn中提供了websocket支持,但是未集成到apistar中,apistellar对二者进行了集成,完美支持websocket。

apistellar项目web请求流程图 apistellar项目微服务及中间件调用解决方案示意图 apistellar项目控制层类图 apistellar项目构建工具设计类图 apistellar项目经典三层架构时序图

Install

# python 3.6+
pip install apistellar

Doc

目录

  1. Quick Start
  2. apistellar项目组成
  3. model的使用方法
  4. controller的使用方法
  5. service的使用方法
  6. Session管理
  7. 使用require实现简单session认证
  8. 增强的EventHook
  9. 错误码处理
  10. 配置信息管理
  11. 自定义项目构建任务
  12. solo任务(离线任务)
  13. 使用集成的IPython进行异步代码的调试
  14. 大文件上传下载
  15. 使用websocket进行通讯
  16. 使用apistellar测试插件pytest-apistellar进行单元测试
  17. model持久化方案
  18. API接口文档自动生成
  19. RESTFul RPC客户端驱动包一键生成
  20. 全局对象

参考资料

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for apistellar, version 1.3.9
Filename, size File type Python version Upload date Hashes
Filename, size apistellar-1.3.9.tar.gz (55.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page