Questions tagged [api]
An application programming interface (API) is the specification for which software is meant to be used by other software.
1,321 questions
10
votes
5
answers
1k
views
How to deal with public vs private version of same resource in a RESTFul API?
I am having a hard time to deal with one particular issue in API design that might be very common. Let me give the concrete example I have: I am writing a RESTFul API for a store and have the ...
- 5,105
2
votes
2
answers
323
views
UML Use Case Diagram: Should different external APIs be modeled as separate actors? [duplicate]
I’m modeling a use case diagram for a real estate search application.
In my system, I use two different external services for geolocation features:
OpenStreetMap (used in the frontend to display maps)
...
- 555
1
vote
2
answers
218
views
Is integration-testing all services the best approach?
I am building an API project, where I have a controller called C1, which calls service S1. Within this service, there are multiple method invocations to services S2and S3 and S4, as well as a call to ...
1
vote
1
answer
248
views
Should pagination metadata like totalCount be included in the ETag for cached paginated API responses?
I am currently rethinking my API response schema and caching strategy while implementing ETag-based caching for a paginated REST API (for example, listing places).
Each paginated response looks like ...
- 19
1
vote
1
answer
348
views
Can I get Open Graph Protocol data without behaving as a web scraper?
In general, to get Open Graph protocol (OGP) data for a given web page, one would need to retrieve the actual HTML, and then extract the meta tags from it.
However, this has two problems:
Instead of ...
- 119
2
votes
2
answers
161
views
How to deal with a poorly documented AWS SQS feed for a security product API?
I’m integrating with the Ajax Enterprise API which exposes an AWS SQS feed for device events and notifications. The API documentation is here: Ajax Enterprise API Docs.
Each SQS message supplies an ...
- 129
1
vote
2
answers
356
views
API supporting multiple authentication providers?
I am currently looking at building an API server that will support multiple authentication providers (Google, GitHub, Keycloak, etc) and I am trying to work out what’s a good way to go about it. Two ...
- 119
3
votes
2
answers
724
views
What is a good approach to sync remote API data to a database?
Problem statement
We have a remote API that can be queried to fetch some arbitrary objects (we're expecting around 500 thousand records). Our application needs fast access to this data (faster than ...
- 141
1
vote
5
answers
491
views
Conventions and separation of concerns for controllers
I am currently working on a project using .NET APIs and have a few questions regarding controller design. Specifically, I have separate controllers for users and orders, and I am considering the best ...
- 19
1
vote
1
answer
225
views
Disable tenants in multi tenant SaaS app
I am building an app where I have tenants and each tenant can have multiple users. The users can do multiple things in the application and these functionalities also are kind of independent from each ...
- 55
2
votes
3
answers
3k
views
How to design for API use cases that need different data from the same table?
I am building a web application. This application is meant to be a home for player rankings and tournament results for a competitive community. I have planned to do this in three layers: a database to ...
- 39
3
votes
1
answer
388
views
Designing a Role-Based Permission System for FastAPI: Integer Roles vs Database Roles?
Problem:
I am building a FastAPI based API and need to design a role-based permission system for authorization. Users can have one of three roles: Admin, Developer, and Operator. These roles are ...
- 141
-1
votes
1
answer
102
views
Why would SMHI's weather API have this scaling for cloud coverage?
SMHI´s API have the below documentation for its properties. What intrigued me is the value range (0-8) for 'tcc_mean'.
Not only does it differ from other properties on the API, for example humidity ...
- 313
0
votes
1
answer
148
views
OpenAPI - `v0.x.x` as a way to denote unstability
In OpenAPI, is there a convention for denoting that your API is not stable yet?
In semantic versioning, the v0.x.x version number is usually used to indicate that the project is not stable yet. ...
- 133
0
votes
2
answers
187
views
Why did IHVs have never extended Direct3D through the facilities of COM on which it is based?
It is well known that Direct3D, unlike OpenGL, was never extensible in itself - a deliberate choice of Microsoft to favor the average user's expectations of predictable behavior and inherent ...
- 103