bungie_api_dart 1.13.0

  • README.md
  • Installing
  • Versions
  • 40

Bungie API Dart support

This project implements Dart definitions and API helpers for the Bungie.net API. It's based on bungie-api-ts that is meant for use in [Destiny Item Manager] (http://destinyitemmanager.com), but should be general enough to use in any project. The code is completely generated from Bungie's documentation - I considered using something like Swagger Codegen, but instead opted for a custom generator so we could make the result as nice as possible.

Install

add this to your dependencies block in pubspec.yaml

dependencies:
  bungie_api_dart:
    git: https://github.com/marquesinijatinha/bungie-api-dart

Interfaces and Enums

There are definitions for every type defined in the Bungie.net services. See their documentation for a list - the interface names are the last part of the full name (for example, Destiny.Definitions.DestinyVendorActionDefinition becomes DestinyVendorActionDefinition). There are a few exceptions, like SingleComponentResponseOfDestinyInventoryComponent, which have been mapped into nicer forms like SingleComponentResponse<DestinyInventoryComponent>, and the server responses, which are now ServerResponse<T> instead of something like DestinyCharacterResponse.

API Helpers

In addition to the types, there are also simple helper functions for each API endpoint. They define the inputs and outputs to that endpoint, and will call a user-provided function with HTTP request info that you can then use to make an HTTP request. This pattern was used so the API helpers could provide full type information. These helpers are not a full API client - they assist in building one. An example:

import 'dart:async';
import 'package:http/http.dart' as http;
import 'package:bungie_api_dart/destiny2.dart';

class BungieApiService{
  Future<ServerResponse<DestinyManifest>> getManifest(){
    return getDestinyManifest(new Client());
  }
}
class Client implements HttpClient{
  static const API_KEY = "your_key";
  @override
    Future<Object> request(HttpClientConfig config) {
      if(config.method == 'GET'){
        return http.get(config.url, headers: {'X-API-Key': API_KEY});
      }
      return http.post(config.url, headers: {'X-API-Key': API_KEY});
    }
}

Build

./install.sh && ./build.sh

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  bungie_api_dart: ^1.13.0

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter packages get

Alternatively, your editor might support pub get or flutter packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:bungie_api_dart/app.dart';
import 'package:bungie_api_dart/app/api.dart';
import 'package:bungie_api_dart/app/interfaces.dart';
import 'package:bungie_api_dart/common.dart';
import 'package:bungie_api_dart/communitycontent.dart';
import 'package:bungie_api_dart/communitycontent/api.dart';
import 'package:bungie_api_dart/communitycontent/interfaces.dart';
import 'package:bungie_api_dart/content.dart';
import 'package:bungie_api_dart/content/api.dart';
import 'package:bungie_api_dart/content/interfaces.dart';
import 'package:bungie_api_dart/destiny2.dart';
import 'package:bungie_api_dart/destiny2/api.dart';
import 'package:bungie_api_dart/destiny2/interfaces.dart';
import 'package:bungie_api_dart/fireteam.dart';
import 'package:bungie_api_dart/fireteam/api.dart';
import 'package:bungie_api_dart/fireteam/interfaces.dart';
import 'package:bungie_api_dart/forum.dart';
import 'package:bungie_api_dart/forum/api.dart';
import 'package:bungie_api_dart/forum/interfaces.dart';
import 'package:bungie_api_dart/groupv2.dart';
import 'package:bungie_api_dart/groupv2/api.dart';
import 'package:bungie_api_dart/groupv2/interfaces.dart';
import 'package:bungie_api_dart/http.dart';
import 'package:bungie_api_dart/platform.dart';
import 'package:bungie_api_dart/trending.dart';
import 'package:bungie_api_dart/trending/api.dart';
import 'package:bungie_api_dart/trending/interfaces.dart';
import 'package:bungie_api_dart/user.dart';
import 'package:bungie_api_dart/user/api.dart';
import 'package:bungie_api_dart/user/interfaces.dart';
  
Version Uploaded Documentation Archive
1.13.0 Sep 26, 2018 Go to the documentation of bungie_api_dart 1.13.0 Download bungie_api_dart 1.13.0 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
50
Overall:
Weighted score of the above. [more]
40
Learn more about scoring.

We analyzed this package on Dec 5, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.1.0
  • pana: 0.12.7

Platforms

Detected platforms: Flutter, web, other

No platform restriction found in libraries.

Health suggestions

Fix lib/app/interfaces.dart. (-0.50 points)

Analysis of lib/app/interfaces.dart reported 1 hint:

line 13 col 8: Unused import: '../common.dart'.

Fix lib/user/interfaces.dart. (-0.50 points)

Analysis of lib/user/interfaces.dart reported 1 hint:

line 13 col 8: Unused import: '../common.dart'.

Format lib/app/api.dart.

Run dartfmt to format lib/app/api.dart.

Fix additional 18 files with analysis or formatting issues.

Additional issues in the following files:

  • lib/common.dart (Run dartfmt to format lib/common.dart.)
  • lib/communitycontent/api.dart (Run dartfmt to format lib/communitycontent/api.dart.)
  • lib/communitycontent/interfaces.dart (Run dartfmt to format lib/communitycontent/interfaces.dart.)
  • lib/content/api.dart (Run dartfmt to format lib/content/api.dart.)
  • lib/content/interfaces.dart (Run dartfmt to format lib/content/interfaces.dart.)
  • lib/destiny2/api.dart (Run dartfmt to format lib/destiny2/api.dart.)
  • lib/destiny2/interfaces.dart (Run dartfmt to format lib/destiny2/interfaces.dart.)
  • lib/fireteam/api.dart (Run dartfmt to format lib/fireteam/api.dart.)
  • lib/fireteam/interfaces.dart (Run dartfmt to format lib/fireteam/interfaces.dart.)
  • lib/forum/api.dart (Run dartfmt to format lib/forum/api.dart.)
  • lib/forum/interfaces.dart (Run dartfmt to format lib/forum/interfaces.dart.)
  • lib/groupv2/api.dart (Run dartfmt to format lib/groupv2/api.dart.)
  • lib/groupv2/interfaces.dart (Run dartfmt to format lib/groupv2/interfaces.dart.)
  • lib/http.dart (Run dartfmt to format lib/http.dart.)
  • lib/platform.dart (Run dartfmt to format lib/platform.dart.)
  • lib/trending/api.dart (Run dartfmt to format lib/trending/api.dart.)
  • lib/trending/interfaces.dart (Run dartfmt to format lib/trending/interfaces.dart.)
  • lib/user/api.dart (Run dartfmt to format lib/user/api.dart.)

Maintenance issues and suggestions

Maintain CHANGELOG.md. (-20 points)

Changelog entries help clients to follow the progress in your code.

The description is too short. (-20 points)

Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package. Common file name patterns include: main.dart, example.dart or you could also use bungie_api_dart.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.58.0 <3.0.0