When designing an enterprise API, what level is appropriate for separating libraries?
Assume we are developing a REST system for an enterprise company to expose the companies resources in a Java based application. Ultimately you have one web application, and domain libraries. My question is to where components and services should live in these domain libraries and what should exist in the application itself.
When should code favour optimization over readability and ease-of-use?
I am in the process of designing a small library, where one of my design goals is that the API should be as close to the domain language as possible. While working on the design, I’ve noticed that there are some cases in the code where a more intuitive, readable attribute/method call requires some functionally unnecessary encapsulation. Since the final product will not necessarily require high performance, I am unconcerned about making the decision to favour ease-of-use in my current project over the most efficient implementation of the code in question.
How to document requirements for an API systematically?
I am currently working on a project, where I have to analyze the requirements of two given IT systems, that use cloud computing, for a Cloud API. In other words, I have to analyze what requirements these systems have for a Cloud API, such that they would be able to switch it, while being able to accomplish their current goals.
API Auth vs User Auth
I have read many posts and articles on this topic but still cant connect the dots. I want to make a Rails app that is strictly a JSON API maybe using Sinatra or the rails-api gem. I also want to make both a web client app and an iPhone app which consumes the API. No plans on letting third party dev’s use it.
How should an API use http basic authentication
When an API requires that a client authenticates to it, i’ve seen two different scenarios used and I am wondering which case I should use for my situation.
How should an API use http basic authentication
When an API requires that a client authenticates to it, i’ve seen two different scenarios used and I am wondering which case I should use for my situation.
What do ptLineDist and relativeCCW do? [closed]
Returns the distance from a point to this line. The distance measured is the distance between the specified point and the closest point on the infinitely-extended line defined by this Line2D. If the specified point intersects the line, this method returns 0.0
How to document experimental or incomplete APIs like @deprecated?
Is there a good term that is similar but different than “deprecate” to mean that a method or API is in the code base but should not be used because its implementation is not complete or will likely change? (Yeah, I know, those methods shouldn’t be public, yada yada yada. I didn’t create my situation, I’m just trying to make the best of it.)
Directly copying third-party API
I’m currently planning on implementing API for HgLab and the obvious role model for me here is GitHub.
What is the need for ‘discoverability’ in a REST API when the clients are not advanced enough to make use of it anyway?
The various talks I have watched and tutorials I scanned on REST seem to stress something called ‘discoverability’. To my limited understanding, the term seems to mean that a client should be able to go to http://URL – and automatically get a list of things it can do.