AngularJS resource optional path parameters

Question

I'm using an AngularJS $resource factory to access a client REST services. Some of the parameters are defined with optional path parameters rather than query parameters.

Case 1:

I call myUrl/application-:applicationID/limit-:limit.json

with:

{
    applicationID:"1234",
    limit: 10
}

I get the correct URL of myUrl/application-1234/limit-10.json

Case 2:

I call myUrl/application-:applicationID/limit-:limit.json

with:

{
    applicationID:"1234"
}

I want the resulting url to ignore the optional limit parameter and collapse down to myUrl/application-1234.json

However, what I get is myUrl/application-1234/limit-.json

*EDIT I have several API categories eg Foo1, Foo2, and each has several endpoints eg endPoint1, endPoint2 and using the method in @Deiter's post, I can't see a way to cleanly list all my resources without using temporary category names then binding them all together at the end.

MyServices.factory ( 'MyAPI', ['$resource',

function ( $resource ) {

    return {

    Foo1: $resource ( '', 
    {                       
        application: "@applicationID",
        limit: "@limit"
    }, 
    {           
        endPoint1: {
            ...
        },
        endPoint2: { 
            url: "myURL/application-:applicationID/limit-:limit.json",
            method:'GET', 
            isArray:true
        },
    }),     

    Foo2: $resource ( '', 
    {                       
        application: "@applicationID"
    }, 
    {           
        endPoint1: { 
            ...
        },
        endPoint2: { 
            ...
        }
    }),             
}               
}]);

Example call:

MyAPI.Foo1.endPoint1 ( { application: "1", limit: 5 } ); 
MyAPI.Foo2.endPoint2 ( { application: "1" } );

Possible duplicate of optional-url-parameters-in-angularjs-resource — Dieterg
– Dieterg, Commented Feb 6, 2014 at 13:49
I've edited my original post to show my current structure as I'm not sure how to cleanly integrate the method in your post. — user3279701
– user3279701, Commented Feb 6, 2014 at 14:54

Matt Way · Accepted Answer · 2014-02-06 14:27:37Z

1

You could use the related answer given in the comments by @Dieter, and create separate $resources, but I would suggest simply making each piece of the URL consistent. Do this by either:

1) Removing the static component of each variable part (eg. myUrl/1234/10)

2) Passing the actual value to the URL that you want to use, and keeping the entire part variable (eg. myUrl/:applicationID/:limit, and pass in application-1234 & limit-10)

answered Feb 6, 2014 at 14:27

Matt Way

33.3k10 gold badges85 silver badges86 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

user3279701 Over a year ago

I've edited my original post to show the current structure. If I understand you correctly, you suggest that I pass in the key and value pair in the string parameter rather than just the value?

Matt Way Over a year ago

Yeah. But I also feel like the application- and limit- are quite redundant.

user3279701 Over a year ago

Thanks. I agree with you about the url structure but there are quite a lot of endpoints and it's already been deployed on a large multi-platform site, so unfortunately it's very unlikely they will change it.

Collectives™ on Stack Overflow

AngularJS resource optional path parameters

1 Answer 1

3 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related