asp.net web api - how to implement Complex Web API queries in ASP Core -


i'm new web api design, i've tried learn best practices of web api design using these articles:

1.microsoft rest api guidelines

2.web api design-crafting interfaces developers love "apigee"

apigee recommending web api developers use these recommendations have better apis. quote here 2 of recommendations: need c# code implementing these recommendations in web apis (in asp core) back-end native mobile apps , angularjs web site.

  1. sweep complexity behind ‘?’ apis have intricacies beyond base level of resource. complexities can include many states can updated, changed, queried, attributes associated resource.

make simple developers use base url putting optional states , attributes behind http question mark. red dogs running in park:

get /dogs?color=red&state=running&location=park

  1. partial response allows give developers information need.

take example request tweet on twitter api. you'll more typical twitter app needs - including name of person, text of tweet, timestamp, how message re-tweeted, , lot of metadata.

let's @ how several leading apis handle giving developers need in responses, including google pioneered idea of partial response.

linkedin

/people:(id,first-name,last-name,industry)

this request on person returns id, first name, last name, , industry.

linkedin partial selection using terse :(...) syntax isn't self-evident.

plus it's difficult developer reverse engineer meaning using search engine.

facebook

/joe.smith/friends?fields=id,name,picture

google

?fields=title,media:group(media:thumbnail)

google , facebook have similar approach, works well.

they each have optional parameter called fields after put names of fieldsyou want returned.

as see in example, can put sub-objects in responses pull in other information additional resources.

add optional fields in comma-delimited list

the google approach works extremely well.

here's how information need our dogs api using approach:

/dogs?fields=name,color,location

now need c# code handles these kind of queries or more complex this:

api/books/?publisher=jat&writer=tom&location=la?fields=title,isbn?$orderby=location desc,writerlimit=25&offset=50

so web api users able send kind of requests want different complexities, fields, ordering,... based on needs.


Comments

Post a Comment

Popular posts from this blog

jOOQ update returning clause with Oracle -

according http://www.jooq.org/doc/3.8/manual/sql-building/sql-statements/update-statement/ jooq doesn't support returning clause in update statements databases except firebird , postgres. does know, still correct oracle jooq? according oracle's documentation, oracle db supports returning clase delete, insert, or update statements. incorrect manual you're right - manual wrong , should fixed: https://github.com/jooq/jooq/issues/5470 single row update returning jooq 3.8 added support single row update .. returning statements. internally, uses callablestatement , pl/sql block of form: begin update "my_table" set "my_table"."column" = 'xyz' "my_table"."id" = 1 returning "my_table"."id", "my_table"."column" ?, ?; ? := sql%rowcount; end; the relevant issue is: https://github.com/jooq/jooq/issues/5190 multi row update returning a...
Read more

java - Warning equals/hashCode on @Data annotation lombok with inheritance -

i have entity inherits other. on other hand, i'm using lombok project reduce boilerplate code, put @data annotation. annotation @data inheritance produces next warning: generating equals/hashcode implementation without call superclass, though class not extend java.lang.object. if intentional, add '@equalsandhashcode(callsuper=false)' type. is advisable add annotation @equalsandhashcode (callsuper = true) or @equalsandhashcode (callsuper = false) ? if not added, 1 callsuper=false or callsuper=true ? the default value false . 1 if don't specify , ignore warning. yes, recommended add @equalsandhashcode annotation on @data annotated classes extend else object. cannot tell if need true or false , depends on class hierarchy, , need examined on case-by-case basis. however, project or package, can configure in lombok.config call super methods if not direct subclass of object. lombok.equalsandhashcode.callsuper = call for configuration system ...
Read more

java - BasicPathUsageException: Cannot join to attribute of basic type -

i using java 8 jpa (hibernate 5.2.1). have clause works perfectly, until introduce clause make use foreign key table values too. i getting following error: basicpathusageexception: cannot join attribute of basic type i think problem related fact have join table, , not sure how create join using join table. employee - employee_category - category model (employee.java): @manytomany(cascade = cascadetype.all, fetch=fetchtype.eager) @jointable ( name="employee_category", joincolumns={ @joincolumn(name="emp_id", referencedcolumnname="id") }, inversejoincolumns={ @joincolumn(name="cat_id", referencedcolumnname="id") } ) private set<category> categories; model (category.java): @id private string id; jpa when introduce following code, fails error above (i think problem new piece of code): join<t, category> category = from.join("id"); predicates.add(criteriabuilder.like(category....
Read more