API

本节介绍Feathers的所有API及其各个模块.

• API

核心

Core: Feathers核心功能

• 应用
  • .use(path, service)
  • .service(path)
  • .hooks(hooks)
  • .publish([event, ] publisher)
  • .configure(callback)
  • .listen(port)
  • .setup([server])
  • .set(name, value)
  • .get(name)
  • .on(eventname, listener)
  • .emit(eventname, data)
  • .removeListener(eventname, [ listener ])
  • .mixins
  • .services
  • .defaultService
• 服务
  • 服务方式
  • Feathers功能
• 钩子
  • 快速示例
  • 钩子功能
  • 钩子上下文
  • 钩子流
  • 异步钩子
  • 注册钩子
  • 应用程序挂钩
• 事件
  • EventEmitters
  • 服务事件
  • 自定义事件
• 事件频道
  • 例如
  • 连接
  • app.on(‘logout’)
  • 频道
  • 出版
  • 保持频道更新
• 错误
  • Feathers 错误
  • 自定义错误
  • 例子
  • 服务器端错误
  • 错误处理
• 配置
  • 用法
  • 更改配置目录的位置
  • 变量类型
  • 例
• REST transport

传输层

将Feathers应用程序公开为API服务器

• Express
  • express(app)
  • express()
  • app.use(path, service|mw|[mw])
  • app.listen(port)
  • app.setup(server)
  • express.rest()
  • express.notFound(options)
  • express.errorHandler()
  • 路由
• Socket.io
  • 配置
  • params
• Primus
  • 配置
  • params

客户端

有关如何在客户端上使用Feathers的更多详细信息

• Feathers 客户端
  • Node
  • React Native
  • 模块加载器
  • @feathersjs/client
• REST客户端
  • @feathersjs/rest-client
  • HTTP API
• Socket.io 客户端
  • @feathersjs/socketio-client
  • 直接连接
• Primus 客户端
  • 加载Primus客户端库
  • 客户端在NodeJS中使用
  • @feathersjs/primus-client
  • 直接连接

认证

Feathers认证机制

• 认证
  • 互补插件
  • app.configure(auth(options))
  • 选项
  • app.service(‘authentication’)
  • app.passport
  • auth.hooks.authenticate(strategies)
  • 认证事件
  • 快递中间件
  • 完整的例子
• 验证客户端
  • app.configure(auth(options))
  • Options
  • app.authenticate()
  • app.authenticate(options)
  • app.logout()
  • app.passport
  • Authentication Events
  • app.on(‘authenticated’, callback)
  • app.on(‘logout’, callback)
  • app.on(‘reauthentication-error’, errorHandler)
  • Hooks
  • Complete Example
• 本地验证
  • Configuration
  • Options
  • hooks
  • Verifier
  • Client Usage
• JWT身份验证
  • Configuration
  • Verifier
  • Client Usage
• OAuth1 身份验证
  • Configuration
  • Options
  • Verifier
  • Customizing The OAuth Response
  • Client Usage
• OAuth2身份验证
  • Configuration
  • Options
  • Verifier
  • Customizing The OAuth Response
  • Client Usage

数据库

简化常见的数据库适配器API和查询机制

• 数据库适配器
  • 内存/文件系统
  • SQL
  • NoSQL
• 通用API
  • service([options])
  • 分页
  • 服务方式
  • 扩展适配器
• 查询
  • Equality
  • $limit
  • $skip
  • $sort
  • $select
  • $in, $nin
  • $lt, $lte
  • $gt, $gte
  • $ne
  • $or
  • 搜索