ngApi

An AngularJS module that makes your APIs working in the Angular Way. You only write html tag , DON'T NEED TO write too many Ajax line by javascript in your angualr controller!!!!! lol

Angular Core Dependency: >=1.2.3

Module License: MIT

Added by: Sam Deering

GitHub

Repository

iamblue/ngapi

Stats

Stars: 9

Watchers: 9

Forks: 0

Author

Blue chen
Blue chen

Module Description

ngApi

An AngularJS module that makes your APIs working in the Angular Way. You only write html tag , DON'T NEED TO write too many Ajax by javascript in your angualr controller!!!!! lol

Example:

<input type="" ng-model="loginname"/>
<input type="" ng-model="loginemail"/>
<input type="" ng-model="loginpassword"/>

<a ng-api="(loginname:string||loginemail:email||loginpassword:nospace)(post:/api/login)" api-success="if you have or not" api-error="if you have or not">send</a>

##Description

  • (loginname:string...):
  1. loginname means it will retreive loginname (ng-model's data), and string means you will validate loginname (ng-model's data) whether be a string.

    In this module, we have four validate methods initailly:

     1.email 
     2.number 
     3.string 
     4.nospace
     
    

    If you want to expand validate methods, see

  2. loginname, loginemail , loginpassword will be sent by ajax data , look like following:

    data:{
        loginname:loginname,
        loginemail:loginemail,
        loginpassword:loginpassword
    }
  1. More infomations: see
  • (post:/api/login): post means it will post to /api/login.

Install

bower install ngapi

Add following into your Html <head>:

<script src="bower_components/ngapi/ngapi.js"></script>

Usage

Require ngapi and Inject the Services

Init:

angular.module('yourApp', ['ngapi'])

Setting API constant:

For example :

.constant('api', {
    url: {  // must write it!
        routes: 'http://localhost:3000/youmeb/routes.json'
    },
    validate: {  // If you have, write it.
        //Input your setting validate way
    },
    crypto: function(){}, // If you have, write it. 
    cnonce: 'cnonce', // If you have, write it.
})

Explain above api :

url:

  • For example: http://127.0.0.1:3000
.constant('api',{
    //....
    url: 'http://127.0.0.1:3000'
})
  • If you have all of your api routes (json) from your api server, try that:
.constant('api',{
    //...
    url: {
        routes:'http://127.0.0.1:3000/youmeb/routes.json'
        //you can add many routes , ngapi will combine it to a scope.
    }
});

==> more info: see

validate:

==> more info: see

crypto && cnonce:

==> more info: see

Setting ng-api style in yout HTML : ng-api = "(data)(api)"

  1. data : (model_name : validate ||.....)

    1. model_name
    2. validate
  2. api:

  • (request:path): request method: post , get , restfullogin

    For example: post:/api/getnavs , get:/api/getnavs , restfullogin:/api/rest-auth/login ...etc

  • (routes.api.getnavs):

    if you use:

.constant('api',{
    //...
    url: {
        routes:'http://127.0.0.1:3000/youmeb/routes.json'
        //you can add many routes , ngapi will combine it to a scope.
    }
});

And the json content like that:

{
    api.getnavs: {
        path: "/api/getnavs",
        methods: [
            "get"
        ]
    }
}

You can use (routes.api.getnavs) , it will help you retreive get and /api/getnavs data.

After sending api , it response success callback / error callback:

You can use api-success or api-error to callback it.

<a ng-api="(loginname:string||loginemail:email||loginpassword:nospace)(post:/api/login)" api-success="your scope function" api-error="your scope function">send</a>
    

Expand

If you want to expand validate libery:

.constant('api',{
    //....
    validate:{
        date: function(){
        // your new validate method
        }
        //....
    }
});

If you want to authentication login by RESTful architecture

On a common REST-authentication architecture, we need browser make a Cnonce constant and crypo your "password code"+snonce( nonce form server)+c_nonce and send it back your server.

  • Step1: Make a Cnonce :
.constant('api',{
    //....
    cnonce:'cnonce',
})  // 'cnonce' can include a function which will make a new cnonce code 
  • Step2: Add a apicrypto algo:
.constant('api',{
    //....
    cnonce: 'cnonce',
    crypto: function(){
        //your crypto algo, for example :sha1,md5 ... etc
    }
})

###Reference:

About REST-Authentication, I sugguest you to read following paper:

Module stats last updated: 2015-06-04 11:08:46

Disclaimer: Some data on this page may have been gathered from the authors GitHub respository. If you see any mistakes or outdated information please let us know. Thanks!