I completely agree; a URI expresses identity, identity doesn’t change when a new version is introduced. There might be new URIs for additional concepts, of course, and existing URIs might redirect … but including a “v2” in the URI smells RPCish to me. Note that this has got nothing to do with REST, really, as … Read more
Try adding a first, required argument, which must be a group of query filters. Thus, # q({‘id’: 5}, 2, 50) def q(filters, page=0, page_size=None): query = session.query(…).filter_by(**filters) if page_size: query = query.limit(page_size) if page: query = query.offset(page*page_size) return query or, # q(Model.id == 5, 2, 50) def q(filter, page=0, page_size=None): query = session.query(…).filter(filter) if page_size: … Read more
to me, the most RESTful way of solving your problem is using the approach number 2 with a slight modification. From a theoretical point of view, you just have valid identification code to identify your order. At this point of the design process, it isn’t important whether your identification code is an id or an … Read more
According to this Wikipedia article, the endpoint is a web service, defined by a WSDL file, and does nothing more than define the address or connection point to a web service. It is typically represented by a simple HTTP URL string. Microsoft uses the term endpoint in various contexts, but they all amount to the … Read more
Why do you need sessions? Is it for Authentication and Authorization reasons? If so I would use http basic with SSL or digest. As such there is no start or end session, because http is stateless and security headers are sent on each request. Suggestion of upload resource would be to directly map as private … Read more
We’re doing some research in this area ourselves. Not a lot out there in terms of “gold standard” for website API references. The most common website APIs referenced are: Google APIs http://developers.google.com/api-client-library/java/apis Amazon S3 http://docs.amazonwebservices.com/AmazonS3/latest/API/ Twitter https://dev.twitter.com/ Facebook http://developers.facebook.com/ LinkedIn http://developer.linkedin.com/index.jspa Delicious http://delicious.com/help/api YouTube http://www.youtube.com/dev Netflix http://developer.netflix.com/ Sun Cloud API http://kenai.com/projects/suncloudapis/pages/Home Another list here: http://www.pingable.org/the-top-15-web-apis-for-your-site/ … Read more
Let’s look at what the docs say: This class models a quantity or amount of time in terms of seconds and nanoseconds. That basically means that the unit used to store the amount of time represented is seconds. For example, to store the duration 5 minutes and 10 nanoseconds, 300 (seconds) and 10 (nanoseconds) are … Read more
Well, the short definition of the law shortens it too much. The real “law” (in reality advice on good API design) basically says: Only access objects you created yourself, or were passed to you as an argument. Do not access objects indirectly through other objects. Methods of fluent interfaces often return the object itself, so … Read more
I just found out that I can do this with the .save method: return this.taskRepository.save({ id: task.id, state, dueDate }); According to the docs (section save), partial updates are supported as well: Also supports partial updating since all undefined properties are skipped.
In API design I’ve always found this keynote very helpful: How to Design a Good API and Why it Matters – by Joshua Bloch Here’s an excerpt, I’d recommend reading the whole thing / watching the video. II. General Principles API Should Do One Thing and Do it Well API Should Be As Small As … Read more