Questions tagged [sdk]
A set of development tools that allows for the creation of applications for a certain software package
29 questions
1
vote
2
answers
139
views
Integration testing strategy for a volatile domain
Imagine following scenario:
Our team is working on a mobile project in biometrics. The team delivers a client facing SDK. Our work relies on another internal team, that is delivering algorithms in a ...
2
votes
2
answers
622
views
Is trunk-based development viable for SDK development?
Is trunk-based development (TBD) viable for development of software where versioning, compatibility, long term support and service level agreements (SLA) play a big role for business (e.g. libraries, ...
0
votes
4
answers
168
views
Should I Decompose Client Classes?
I'm writing an SDK for the European Space Agency's DISCOs API.
This has around 10 endpoints with different sets of query parameters, each of which returns a different payload type with different link ...
0
votes
3
answers
197
views
Should the client silently fix a possible error or should it let the user of the client know about the error?
I'm building a client for an API.
The API takes a query param that looks something like this 2-10, that's a range and notice that it uses a hyphen (-).
Usually, data comes from another place using en ...
1
vote
1
answer
2k
views
SDK design: Should I parse enum as string or as enum?
I am building a SDK that will simplify the use of my API.
The problem is if when I have to return property of type enum. For example, I use strings instead of int for displaying enum such as
{
"...
-1
votes
1
answer
509
views
One Super App or Many Single-Purpose Apps
While Players like Rappi/Alibaba / Wechat have gone the super app way, i.e on single app to host many unrelated services, Ecosystems like Google, Amazon etc still have multiple single purpose ...
4
votes
3
answers
842
views
Should An SDK Have Logging in the API
I am working on building a API and SDK for a web service. My question is what is the correct practice for logging. Should the SDK do logging for the API methods? All the SDKs I have seen do not do ...
-3
votes
1
answer
114
views
Best Practices for Building An API and SDK for a Legacy Application
I have been given a task to take on a legacy application (which has a very poor API in terms of user experience, is undocumented largely, and performs slowly) and build a new API and SDK to improve ...
1
vote
1
answer
126
views
Propper way to organize and maintain project SDK
There is a C++ project. It is supposed to be executed on x86 CPU, target OS are Ubuntu 18.04 and Red Hat 7.4.
There is an idea that there is almost no need to install anything project specific on a ...
1
vote
2
answers
174
views
What's the most common way to handle API integration?
I work with some not-monolithic applications, meaning that at some level, it depends on other applications to do the work. At the moment, each application on our stack, when there is an API change, ...
0
votes
2
answers
2k
views
Validating requests to API have come from a valid source
I am currently working on a project where I am developing a library which will do HTTP POSTs to a backend service on my server. The data that the backend service receives is processed and stored in a ...
7
votes
3
answers
3k
views
How should I write automated tests for an SDK without making live calls to the API?
I've developed an SDK (link) for a RESTful API in PHP, and my automated tests (example) are actually live calls against the API, which is bad for multiple reasons, mainly:
it takes a long time (about ...
2
votes
1
answer
373
views
Method naming convention in SDKs [closed]
I create my API and now I generate SDKs for my users access them. Swagger generates a ugly name, e.g:
public void sellersSellerIdShipmentPost(){
...
}
Of course it's difficult to read and understand....
0
votes
1
answer
74
views
For interaction by other programs: command line, sockets, or something else?
I'm beginning an open-source project for logging work hours. The intention is to build something similar to Git, where instead of pushing code you're pushing information about work hours and progress.
...
0
votes
1
answer
117
views
Sdk building, declare dependencies inside the assembly or use external?
At my company, we're building an SDK consisting of a number of assemblies. For example, we deliver an assembly called Company.Platform.Security that contains the implementation of our authorization ...