View命名规范

url命名规范

  • url接口采用下划线命名法,除特殊缩写以外、一般使用小写单词
    eg:/video_add.sy、/plan_add.sy

  • 同一模块中的同类接口存放在同一层url下
    eg:视频模块配置中的码流配置、检测项目配置都在/conf下
      /conf/stream_add.sy      # 新增码流
      /conf/test_items_add.sy  # 新增检查项目
    

  • 增删改查等基础接口采用统一命名规范
    • 增加:xxx_add.sy
    • 删除:xxx_delete.sy
    • 修改:xxx_update.sy
    • 移动:xxx_move.sy
    • 列表展示:xxx_list.sy
    • 条件查询:xxx_select.sy
    • 单个查询:xxx_retrieve.sy

Module命名规范

  • 每个Module都填写url_prefix,方便不同Module的url区分
    eg:
      video_quality_module = Module('video_quality_module', url_prefix='/video')
    

类名及方法命名规范

  • View层类名与url对应,且采用驼峰命名法
    • 增加:class XxxAdd
    • 删除:class XxxDelete
    • 修改:class XxxUpdate
    • 移动:class XxxMove
    • 列表展示:class XxxList
    • 条件查询:class XxxSelect
    • 单个查询:class XxxRetrieve

  • View层方法名
  • 目前仅支持get、post方法,对应http的GET、POST请求
  • 因为web程序仅支持get、post请求,所以不完全使用restful风格
  • eg:增加、删除、更新、移动等修改数据的接口使用POST请求,查询、列表展示等接口使用GET请求