TMDb

TMDb - 电影数据库

电影数据库 (TMDb) 的 Swift 包 https://www.themoviedb.org

要求

• 斯威夫特 6.0+
• 操作系统
  • macOS 13+
  • iOS 16+
  • watchOS 9+
  • 电视操作系统 16+
  • 视觉操作系统1+
  • 视窗
  • Linux

安装

斯威夫特包管理器

将 TMDb 包作为依赖项添加到您的Package.swift文件中，并将其作为依赖项添加到您的目标。

 // swift-tools-version:5.9

import PackageDescription

let package = Package (
  name : " MyProject " ,

  dependencies : [
    . package ( url : " https://github.com/adamayoung/TMDb.git " , from : " 13.0.0 " )
  ] ,

  targets : [
    . target ( name : " MyProject " , dependencies : [ " TMDb " ] )
  ]
)

Xcode项目

将 TMDb 包添加到项目的包依赖项中。

设置

获取 API 密钥

从电影数据库网站 https://www.themoviedb.org/documentation/api 创建 API 密钥。

快速入门

 let tmdbClient = TMDbClient ( apiKey : " <your-tmdb-api-key> " )

let moviesToDiscover = try await tmdbClient . discover . movies ( ) . results
let fightClub = try await tmdbClient . movies . details ( forMovie : 550 ) 

文档

文档和使用示例可以在 https://adamayoung.github.io/TMDb/documentation/tmdb/ 找到

发展

先决条件

Xcode 16.0+ Swift 6.0+ 自制软件

自制

安装自制程序和以下公式

• 斯威夫特林特
• 快速格式化
• 标记

brew install swiftlint swiftformat markdownlint

提交 PR 之前

单元和集成测试

使用 Swift Test 作为测试框架。不再使用 XCTest。

确保单元测试覆盖所有新代码。如果向调用 TMDb API 端点的服务添加任何新方法，请确保有涵盖这些方法的集成测试。

编码风格

编码风格由swift-format强制执行。

使用以下命令来检查代码库：

make lint

要格式化代码库，请使用：

make format

DocC 文档

确保所有public类、结构、属性和方法都被注释

DocC 文档可以通过以下方式在本地构建和托管

make preview-docs

参见文档 | Apple 开发者文档了解更多详细信息。

CI检查

在提交 PR 之前，请确保所有 CI 检查都将通过：

make ci

CI 检查由以下任务组成：

make lint
make lint-markddown
make test
make test-ios
make test-watchos
make test-tvos
make test-visionos
make test-linux
make integration-test
make build-release
make build-docs

为了运行集成测试，需要设置以下环境变量。

• TMDB_API_KEY - 您的 TMDb API 密钥
• TMDB_USERNAME - 您的 TMDb 用户名
• TMDB_PASSWORD - 您的 TMDB 密码

如果未设置这些环境变量，则在不使用make时将跳过集成测试。

在 Linux 上运行单元测试需要运行 Docker。

参考

• https://www.themoviedb.org
• https://developer.themoviedb.org

执照

该库根据 Apache License 2.0 获得许可。有关详细信息，请参阅许可证。