https://github.com/deraen/angular-http-api

Wrapper around $http with integration for UI-Router
https://github.com/deraen/angular-http-api

Last synced: about 1 month ago
JSON representation

Wrapper around $http with integration for UI-Router

• Host: GitHub
• URL: https://github.com/deraen/angular-http-api
• Owner: Deraen
• License: mit
• Created: 2014-04-12T22:03:26.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-05-22T13:57:26.000Z (over 10 years ago)
• Last Synced: 2024-10-07T17:49:54.361Z (about 1 month ago)
• Language: JavaScript
• Size: 172 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Angular-HTTP-Api

[![Build Status](https://travis-ci.org/Deraen/angular-http-api.svg?branch=master)](https://travis-ci.org/Deraen/angular-http-api)

Provides a way to make http requests where endpoint urls are defined once per project.

## Why not $resource

- All APIs aren't RESTful

## Example

```JavaScript

angular.module('testApp', ['angular-http-api'])

  .factory('Api', function(ApiFactory) {

    var api = ApiFactory;

    return {

      getUsers: api.get('/users'),

      getUser: api.get('/users/:id'),

      newUser: api.post('/users'),

    };

  });

```

## Integration with UI-Router

With [UI-Router](https://github.com/angular-ui/ui-router.git) one can use `resolve`-property

to define dependencies which will be injected into controller. If dependancy is a promise (eg. http-request)

it will be resolved before state transition is completed.

UI-Router also provides a way to preprocess state properties. `angular-http-api.router`-module

provides decorator which implements `resolveApi`-decorator. Examples dir contains a [complete example](./example/resolve.js).

```JavaScript

.state('users', {

  url: '/users',

  abstract: true,

  ...

})

.state('users.list', {

  url: '?start',

  resolveApi: {

    // [name of api call, url params, query params]

    users: ['getUsers', null, {limit: 10, start: '@start'}],

  },

  ...

})

.state('users.detail', {

  url: '/:id',

  resolveApi: {

    user: ['getUser', {id: '@id'}],

  },

  controller: 'UserCtrl',

  template: '
{{user.name}}, {{user.id}}',

})

.controller('UserCtrl', function($scope, user) {

  // Result of http promise is found under data-property

  $scope.user = user.data;

});

```


## TODO

- More documentation

- Test UI-Router decorator automatically

- resolveApi decorator presumes that user has `Api` named factory which defines the endpoints

  - maybe endpoints should be defined using provider? like states etc.

  - Though it would be nice to keep possibility to define multiple APIs

    - `$apiRouterIntegrationThingie.registerEndpointFactoryName('Api');` ?

- Functions as resoveApi map params: `users: ['getUsers', null, {start: function($stateParams) { return $stateParams.page * 10; }}]` ?