All Questions
Tagged with web-api api-design
119 questions
2
votes
3
answers
2k
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
0
votes
1
answer
117
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. ...
- 123
0
votes
1
answer
400
views
Should you use nested routes within NestJS for a "RESTfull" API
Here is an Example API for managing companies, employees, and their children. My entity relationships are as follows:
company -1:n-> employees -1:n-> children
I’ve structured the API routes ...
- 109
1
vote
0
answers
94
views
How to model api error type with errorCode and parameters
I work on a spring kotlin backend which has an angular and a mobile frontend. We are currently working on error handling and we decided that the backend should return an error code, a general message (...
- 119
0
votes
3
answers
222
views
Is it a bad practice to include fields on DELETE requests that will enforce them, but only in on certain environments? [closed]
I've seen similar questions but in this case the code deployed to all stages (local, dev, staging, prod) will be the same.
The idea is to have a special field on one particular request, something like ...
- 119
0
votes
2
answers
55
views
Specifications to build a API context data
I was developing a new API, and some doubts appears about context of payload data. Example:
{
"transaction_id": 123,
"transaction_date": "2022-12-25",
"user_id&...
6
votes
3
answers
3k
views
Difference between API and protocol?
What's the difference between an API and a protocol?
To use a specific example: Is Coinbase's choice to refer to its WebSocket client specification as an "API" appropriate? It seems that ...
- 269
4
votes
3
answers
356
views
Designing an API for international markets
I am working on a REST API for a company that, until recently, has been focused on the Australian market. The result of this is that the API has resources and fields which model the Australian market, ...
- 275
1
vote
0
answers
717
views
How to handle relationships between resources in Restful API
Problem
Hi, we have an API that it's pretty similar to a standard CRM. That is, we have a really big amount of resources (even our own customers can define new resources). All of these resources share ...
0
votes
2
answers
2k
views
REST Api - deleting a resource based on either ID, or its OwnerID
I have this list of Notes:
public static List<Note> _notes = new List<Note> { new Note { Id = new Guid("00000000-0000-0000-0000-000000000001"), CategoryId = "1", ...
-2
votes
1
answer
451
views
How often should I request a token when communicating with a third-party API?
I have an ASP.net web API. I would like to call another API that has an authentication token inside my API.
The code flow is as follows:
My API is called → Get authentication token from 3rd party API →...
- 7
0
votes
1
answer
801
views
How to Properly Design an API Prefetch System
I'm creating an API for a web service. There are a couple of endpoints in this API that require some time (lets say +5min) to compute, so I'm creating a prefetch system that will call in the ...
- 151
1
vote
3
answers
696
views
Is the "archetype controller" really complies with REST architectural style
I've read the Fielding's thesis that defines the REST architectural style and noticed that the defined style appears to significantly conflicts with the so called "archetype controller", ...
2
votes
1
answer
421
views
Best practice for designing a WebAPI for exposing data in a SQL database interacting with C++ and C# applications
I am looking for general guidance or any relevant links for a complex project.
We are a small business that sells a construction materials testing software. The client is a Windows application with ...
- 129
4
votes
7
answers
8k
views
Representing a large list of complex objects in JSON
I am currently developing an API that returns JSON structures. One of the domain objects returned is a time series, which is a potentially large list (many thousands of elements) of complex objects.
...
- 204