https://github.com/isaced/V2exAPI
V2ex API 的 Swift 封装，支持 iOS/macOS (A V2ex API wrapper for iOS/macOS, built with Swift)
https://github.com/isaced/V2exAPI
swift v2ex v2ex-api
Last synced: 4 months ago
JSON representation
V2ex API 的 Swift 封装，支持 iOS/macOS (A V2ex API wrapper for iOS/macOS, built with Swift)
- Host: GitHub
- URL: https://github.com/isaced/V2exAPI
- Owner: isaced
- License: mit
- Created: 2022-07-24T09:52:42.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-29T15:49:44.000Z (almost 2 years ago)
- Last Synced: 2024-10-29T22:56:02.561Z (9 months ago)
- Topics: swift, v2ex, v2ex-api
- Language: Swift
- Homepage:
- Size: 36.1 KB
- Stars: 49
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# V2exAPI
[](https://github.com/isaced/V2exAPI)
[](https://cocoapods.org/pods/V2exAPI)
[](https://github.com/Carthage/Carthage)
[](https://github.com/isaced/V2exAPI)
[](https://github.com/isaced/V2exAPI)
中文｜[English](/README_EN.md)
一个 [V2ex](https://v2ex.com/) API 的 Swift 封装，支持 iOS/macOS，支持 SPM 引入和 async/await 方式调用。
## 特性
- [x] SPM(Swift Package Manager) 支持
- [x] Swift async/await 异步 API
- [x] V2ex API V1 支持度 100%
- [x] V2ex API V2 支持度 100%
- [x] Zero dependency 零三方依赖
## API 支持范围
### V1
| 接口 | 路径 | 进度 |
|------|-------------------------|-----|
| 最热主题 | /api/topics/hot.json | ☑ |
| 最新主题 | /api/topics/latest.json | ☑ |
| 节点列表 | /api/nodes/list.json | ☑ |
| 节点信息 | /api/nodes/show.json | ☑ |
| 用户主页 | /api/members/show.json | ☑ |
| 回复列表 | /api/replies/show.json | ☑ |
### V2
| 接口 | 路径 | 进度 |
|----------------------|--------------------------------|---------|
| 获取最新的提醒 | notifications | ☑ |
| 删除指定的提醒 | notifications/:notification_id | ☑ |
| 获取自己的 Profile | member | ☑ |
| 查看当前使用的令牌 | token | ☑ |
| 获取指定节点 | nodes/:node_name | ☑ |
| 获取指定节点下的主题 | nodes/:node_name/topics | ☑ |
| 获取指定主题 | topics/:topic_id | ☑ |
| 获取指定主题下的回复 | topics/:topic_id/replies | ☑ |
## 安装
### Swift Package Manager
通过 [Swift Package Manager](https://swift.org/package-manager/) 安装 V2exAPI 到你的项目，在 `Package.swift` 中添加：
```swift
.package(name: "V2exAPI", url: "[email protected]:isaced/V2exAPI.git", .upToNextMinor(from: "1.0.0")),
```
在 Xcode 中：
- 菜单 File > Swift Packages > Add Package Dependency
- 搜索 https://github.com/isaced/V2exAPI.git
- 选择 "Up to Next Major" 版本 "1.0.0"
### CocoaPods
```ruby
pod 'V2exAPI', '~> 1.0'
```
## 使用
```swift
import V2exAPI
// 初始化 V2eXAPI 对象
let v2ex = V2exAPI(accessToken: "XXXXX-XXXX-XXXX-XXXX-XXXXXXXXX")
// 获取节点列表
let nodes = try await v2ex.nodesList()
// 获取最新主题
let latest = try await v2ex.latestTopics()
// 获取指定节点下的主题列表
let topics = try await v2ex.topics(nodeName: "swift", page: 1)
// 获取指定主题下的回复
let replies = try await v2ex.replies(topicId: 870607, page: 1)
```
## API 参考
- [V2EX API 接口](https://www.v2ex.com/p/7v9TEc53)
- [API 2.0 Beta](https://v2ex.com/help/api)
API Rate Limit
默认情况下，每个 IP 每小时可以发起的 API 请求数被限制在 120 次。你可以在 API 返回结果的 HTTP 头部找到 Rate Limit 信息：
```
X-Rate-Limit-Limit: 120
X-Rate-Limit-Reset: 1409479200
X-Rate-Limit-Remaining: 116
```
对于能够被 CDN 缓存的 API 请求，只有第一次请求时，才会消耗 Rate Limit 配额。
> Personal Access Token 申请参考：https://v2ex.com/help/personal-access-token
## 使用示例
- [V2exOS](https://github.com/isaced/V2exOS) - 一个用 SwiftUI 编写的 V2ex macOS 客户端
## License
V2exAPI 在 MIT 许可下发布的，有关详细信息，请参阅 [LICENSE](/LICENSE)