web_api 0.0.1

  • README.md
  • CHANGELOG.md
  • Example
  • Installing
  • Versions
  • 27

web_api

A library for creating Restful apis

Usage

The model:

@Serializable() //Each class which is returned by a controller or is a parameter of a controller must have the @Serializable() annotation
class Member{

  int id;
  String email;
  String name;

}

The controller:

class MemberController extends Controller{

  @HttpPost("/members")
  @MemberLinkProvider()
  Member addMember(@Body() Member newMember){
    if(DatabaseDummy.members.length==0){
      newMember.id=0;
    }
    else{
      newMember.id=DatabaseDummy.members.last.id+1;
    }
    DatabaseDummy.members.add(newMember);
    return newMember;
  }

  @HttpGet("/members")
  List<Member> getMembers(){
    return DatabaseDummy.members;
  }

}

Your startup method

HttpServer server = await HttpServer.bind(InternetAddress.LOOPBACK_IP_V4,8080);
RequestMapper requestMapper = new RequestMapper((type){
  if(type == MemberController){
    return new MemberController();
  }
});
requestMapper.addController(MemberController);
requestMapper.handle(server);

For more details look at the example folder.

Features and bugs

Please file feature requests and bugs at the issue tracker.

Changelog

0.0.1

  • Initial version, created by Stagehand

example/main.dart

import 'web_api_example.dart';

void main(){
  new App();
}

1. Depend on it

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


dependencies:
  web_api: "^0.0.1"

2. Install it

You can install packages from the command line:

with pub:


$ pub get

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

3. Import it

Now in your Dart code, you can use:


import 'package:web_api/web_api.dart';
        
Version Uploaded Documentation Archive
0.0.1 Jul 5, 2016 Go to the documentation of web_api 0.0.1 Download web_api 0.0.1 archive

Analysis

This feature is new.
We welcome feedback.
More details: scoring.

We analyzed this package, and provided a score, details, and suggestions below.

  • tool failures on Feb 16, 2018
  • Dart: 2.0.0-dev.20.0
  • pana: 0.10.1

Scores

Popularity:
Describes how popular the package is relative to other packages. [more]
0 / 100
Health:
Code health derived from static analysis. [more]
68 / 100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
32 / 100
Overall score:
Weighted score of the above. [more]
27

Platforms

Detected platforms: other

Primary library: package:web_api/web_api.dart with components: io, mirrors.

Suggestions

  • Fix lib/src/hateoas/link_appender.dart.

    Strong-mode analysis of lib/src/hateoas/link_appender.dart failed with the following error:

    line: 4 col: 42
    The class 'Serializer' doesn't have a constructor named 'Json'.

  • Fix lib/src/request_mapper.dart.

    Strong-mode analysis of lib/src/request_mapper.dart failed with the following error:

    line: 8 col: 86
    The class 'Serializer' doesn't have a constructor named 'Json'.

  • Fix further 2 Dart files.

    Similar analysis of the following files failed:

    • lib/src/response_builder.dart
    • lib/src/parameter_resolver.dart
  • Fix issues reported by dartanalyzer.

    dartanalyzer reported 3 error(s) and 0 warning(s).

  • The description is too short.

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

  • Package is pre-v1 release.

    While there is nothing inherently wrong with versions of 0.*.*, it usually means that the author is still experimenting with the general direction API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.0.0 <2.0.0
func >=0.1.0 <0.2.0 0.1.1 1.0.0
serializer >=0.3.1 <1.0.0 0.7.1
Dev dependencies
mockito >=0.11.0 <0.12.0
test >=0.12.0 <0.13.0