Skip to content

Latest commit

 

History

History
125 lines (88 loc) · 2.42 KB

README.md

File metadata and controls

125 lines (88 loc) · 2.42 KB
Raw

Superhero Api Wrapper Dart

Superhero Api Wrapper for Dart

Usage

  1. Add superhero_api as a dependency in your pubspec.yaml.

    dependencies:
  superhero_api:

  2. Install it

      flutter pub get

  3. And import it

      import 'package:superhero_api/superhero_api.dart';

API

  1. Hero

    • Get All

      returns Future of ResponseList

        await superhero.hero.getAll(ParamsModel params)

    • Get by ID

      returns Future of ResponseSingle

        await superhero.hero.getById(String id)

    • Get by Path

      returns Future of ResponseSingle

        await superhero.hero.getByPath(String path)

    • Get by Query

      returns Future of ResponseList

        await superhero.hero.getByQuery(QueryModel query, { ParamsModel params })

  2. Appearance

    • Get All

      returns Future of ResponseList

        await superhero.appearance.getAll(ParamsModel params)

    • Get by ID

      returns Future of ResponseSingle

        await superhero.appearance.getById(String id)

    • Get by Query

      returns Future of ResponseList

        await superhero.appearance.getByQuery(QueryModel query, { ParamsModel params })

  3. Origin

    • Get All

      returns Future of ResponseList

        await superhero.origin.getAll(ParamsModel params)

    • Get by ID

      returns Future of ResponseSingle

        await superhero.origin.getById(String id)

    • Get by Query

      returns Future of ResponseList

        await superhero.origin.getByQuery(QueryModel query, { ParamsModel params })

  4. Super Power

    • Get All

      returns Future of ResponseList

        await superhero.superPower.getAll(ParamsModel params)

    • Get by ID

      returns Future of ResponseSingle

        await superhero.superPower.getById(String id)

    • Get by Query

      returns Future of ResponseList

        await superhero.superPower.getByQuery(QueryModel query, { ParamsModel params })

Dependency