RentlioApi 0.0.2

RentlioApi 0.0.2

×

测试已测试✓
语言语言 SwiftSwift
许可 MIT
发布上次发布2017年7月
SwiftSwift 版本3.0
SPM支持 SPM✗

由 Juraj Hilje 维护。

RentlioApi 0.0.2

  • 作者：
  • Juraj Hilje

Rentlio API 的 Swift 客户端

Swift 对官方 Rentlio API 的封装。此库深受官方文档的启发，并遵循其中列出的 REST 方法。

Rentlio API 围绕 REST 构建。它有可预测的资源导向 URL，并使用 HTTP 响应代码来指示 API 错误。

所有 API 响应都返回 JSON，包括错误。此外，在请求数据中，JSON 也用于替代表单数据。我们不使用沙箱版本，您可以在其中测试您的集成。相反，您可以使用 DEMO 属性 和其预订来确保不会对真实数据造成损害。

请在使用此库之前 阅读官方文档 https://docs.rentl.io

重要提示：apikey 是私有密钥，允许访问执行 Rentlio 公共 API 中所有可用方法。任何拥有您的 API 密钥的人都将有权读取、创建、更新和删除您私有 Rentlio 账户中的数据。

依赖

集成

您可以使用 CocoaPods 通过将其添加到您的 Podfile 中安装 RentlioApi。

platform :ios, '10.0'
use_frameworks!

target 'MyApp' do
    pod 'RentlioApi'
end

示例项目

获取源代码

$ git clone https://github.com/Rentlio/api.lib.swift.git api.lib.swift && cd $_
$ pod install
$ open api.lib.swift.xcworkspace

基本用法

发送请求

let rentlio = RentlioApi(apikey: "your_apikey")
rentlio.getUser()

// GET /users/me

完成块

rentlio.getUser(
    done: {
        res in
        if let json = res.json {
            print(json)
        }
    }
)

方法

  • getUser()
  • getProperties()
  • getUnitTypes()
  • getUnits()
  • getUnitReservations()
  • getReservations()
  • getServices()
  • createInvoiceItem()
  • getServicePaymentTypesEnum()
  • getReservationStatusesEnum()
  • getCurrenciesEnum()

分支

  • master - 生成分支。为确保使用最新副本，请克隆或分叉此存储库。
  • develop - 活跃的开发分支。请将拉取请求指向此分支。

贡献

准备好提交修复或新特性了吗？请提交拉取请求！并且请 проц.

  • 如果代码有所更改，请运行测试并确保一切仍然正常。
  • 为新的功能编写新的测试。
  • 如有适用，请更新文档注释。
  • 保持现有样式。

联系方式

许可

见LICENSE.