https://github.com/thunder-app/lemmy_api_client
Lemmy API Client built with Dart
https://github.com/thunder-app/lemmy_api_client
api dart lemmy
Last synced: 2 months ago
JSON representation
Lemmy API Client built with Dart
- Host: GitHub
- URL: https://github.com/thunder-app/lemmy_api_client
- Owner: thunder-app
- License: mit
- Created: 2023-06-27T13:46:33.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-12-27T00:11:48.000Z (4 months ago)
- Last Synced: 2024-12-27T01:17:21.116Z (4 months ago)
- Topics: api, dart, lemmy
- Language: Dart
- Homepage:
- Size: 3.26 MB
- Stars: 5
- Watchers: 3
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-lemmy - lemmy_api_client - app/lemmy_api_client)  (Projects / Libraries)
README
# Lemmy Dart API Client
A Lemmy API Client built with Dart. Continuation of the original [Lemmy Dart API](https://github.com/LemmurOrg/lemmy_api_client) and [Liftoff Dart API](https://github.com/liftoff-app/lemmy_api_client).
## Information
Updates are done at a best-effort basis to ensure compatibility with the current major version of Lemmy. Due to the unstable nature of Lemmy API, there will be limited support for the last major version.
Notice: While efforts are made to keep as much parity as possible with the Lemmy API, it is not guaranteed. If a particular endpoint or feature is missing, feel free to create a feature request or a pull request implementing that endpoint.
## Usage
```dart
import 'package:lemmy_api_client/v3.dart';
Future main() async {
// Initialize the Lemmy API Client with the given instance URI
const lemmy = LemmyApiV3('lemmy.ml');
// Fetch posts
final response = await lemmy.run(const GetPosts());
print(response);
}
```
## Conventions
When implementing a new endpoint, try to follow the existing conventions. A basic summary of these conventions are mentioned below.
### API Methods and Naming
Any high-level API methods should be placed under `/api` directory matching the endpoint. For example, `GET /community` should be placed under `api/community/community.dart` file.
- Always attempt to match the naming of the API or model with the [official API client](https://github.com/LemmyNet/lemmy-js-client). This helps with parity checking and general organization.
### Deprecating Fields
When a field or attribute is being deprecated in the upcoming version of Lemmy, mark it as such by **annotating the field with `@deprecated`** and making the field **optional**.
This example shows deprecation for the `community` field. Whenever possible, add an additional comment on which API version deprecates the field
```dart
const factory CommunityView({
required Community community,
required SubscribedType subscribed,
required bool blocked,
required CommunityAggregates counts,
}) = _CommunityView;
```
```dart
const factory CommunityView({
@deprecated Community? community, // v0.18.0 (required) [deprecated in v0.43.0]
required SubscribedType subscribed,
required bool blocked,
required CommunityAggregates counts,
}) = _CommunityView;
```
### Adding Fields
When a field or attribute is introduced in an upcoming version of Lemmy, keep that attribute **optional** regardless of what the Lemmy API version denotes, and denote whether the field is optional/required. This is to ensure compatibility with the current and upcoming version of Lemmy. Furthermore, add a comment to denote which version introduces that field.
This example shows addition for the `follow` field:
```dart
const factory CommunityView({
required Community community,
required SubscribedType subscribed,
required bool blocked,
required CommunityAggregates counts,
}) = _CommunityView;
```
```dart
const factory CommunityView({
required Community community,
required SubscribedType subscribed,
required bool blocked,
required CommunityAggregates counts,
bool? follow, // v0.64.0 (required)
}) = _CommunityView;
```
## Acknowledgements
### Logo
Original Lemmy logo made by Andy Cuccaro (@andycuccaro) under the CC-BY-SA 4.0 license. Remixed by Marcin Wojnarowski (@shilangyu) and re-released under the CC-BY-SA 4.0 license.