Questions tagged [web-api]
Specific APIs that communicate over web protocols, such as ASP.net Web API, as well as APIs that are exposed to web pages for network communication or apps for device communication
0
votes
0answers
12 views
Best way to make insert data in logs web API. REST or WebSockets
I want to make a centralized log web API, so it will have a large amount of data per seconds. the logs will comming from others WEB API
I was thinking if i make the REST API, all of the POST made ...
1
vote
1answer
60 views
Data is in database or get from API, where should API request code goes?
For me, the data I want to retrieve may be in database for which I can use properties of model and also relationships, but if the record is not a property and no relationship exists for that ...
1
vote
1answer
37 views
Recommended manner of installation for an open source web application and api?
I'm currently working on my own open source project.
There are two parts to it at the moment, a .NET core web API and an Angular client side app.
I would like to get your views on installation/setup ...
2
votes
1answer
55 views
Keep Hitting 3rd party API or Store Commonly Queried Data In DB?
Colleague and I have begun a long (and hopefully fruitful) project. I've been building and have come to my first crux, and now I ask the experts of the Stack Exchange for their guidance.
I'll keep ...
0
votes
1answer
59 views
Use same API for both website and other clients or not?
Lets say I am building some large application ( multi-page app ) using Laravel. And laravel will allow me to make an API and a website on the same application.
Since the website and the API ...
-2
votes
1answer
67 views
Is it a good idea to ask for requestId in each API call?
I see some services which takes a requestId from client as the mandatory attribute while some services doesn't. I feel it is a good idea to have a request Id from the clients because it helps in ...
0
votes
1answer
27 views
Retrieving JSON and image representation of a resource
I am developing a RESTful API designed primarily (but not exclusively) for consumption by a web application. For the purposes of this question, the API is a set of GET endpoints. The main endpoint is /...
0
votes
0answers
43 views
Separating models in a Backend-For-Frontend (BFF) API
At the moment I have a frontend client calling several backend REST APIs. For example a call may be to get information about a certain vehicle. Then the client will call REST API A to get some ...
0
votes
1answer
169 views
The Frontend-Backend Vs. Backend-Backend
I've seen this pattern pop up in a couple of different teams. They have a server with a REST API and a frontend web project.
What commonly happens is the frontend developer finds their requests are ...
0
votes
1answer
107 views
Check if user is logged in when using JWT
I have an app that uses JWT tokens for user authorization. Now, I need to be capable of deactivating users (users won't be allowed to use the system but still exist in the database), but as a ...
1
vote
1answer
71 views
Web API POST: single item vs collection
No code to show (and not really a code issue) but I have an iot-ish application running that is using PI Zeroes as clients and they are slow. A single POST takes about 10 seconds round trip, the delay ...
-2
votes
1answer
114 views
How to implement HTTP PUT correctly
I'm really looking for one good example how to PUT operations should be implemented correctly.
What I understood until now:
The operation must be idempotent
When the resource doesn't exists it will ...
91
votes
15answers
16k views
Should we design our code from the beginning to enable unit testing?
There's a debate going on in our team at the moment as to whether modifying code design to allow unit testing is a code smell, or to what extent it can be done without being a code smell. This has ...
0
votes
1answer
56 views
What is the optimal pattern to ensure a priority API gets cycles over its related (non-priority) API?
I have two synchronous web APIs that perform the same work but one needs to be prioritized over the other (the former is called from a client, whereas the latter is a caching optimization for before a ...
1
vote
1answer
92 views
Breaking 3-tier architecture into multi-tier architecture
Recently I have been working on a rather large system with Vue.js for a single page app (SPA) and an API for the backend. The customer is concerned with the security, performance and maintainability.
...
0
votes
2answers
72 views
Unit testing about API endpoints and parameters
Consider a simple web application, I'll use a Python(ish) example, but i think the question is relevant for other languages as well.
The user is trying to fetch a page, and in order to render that ...
1
vote
1answer
85 views
Is Web API suitable as services for IoT?
The issue I care about here is high throughput, there are a lot of sensors (monitoring devices) which send data to the server at high frequency.
It looks really like that we have to use UDP protocol ...
0
votes
1answer
81 views
Is It good practice on API design to use different object model for getting object and creating
While mostly every company got it's standard on APIs, the question just came out after that one of my colleagues stated we must use different object models for creating and getting objects from API.
...
2
votes
1answer
245 views
C# .Net Core API design - interfaces vs DTOs
I'm designing a relatively simple web application using .net core. I've mostly done desktop development in my career so far, so I'm a bit new to the nuances between desktop and web development.
In ...
2
votes
3answers
85 views
Permissive vs. Strict API Message validation
We had a interesting debate today over what our REST API should default to doing when validating a request body where unexpected fields are present. I think we ended the conversation in a good place, ...
0
votes
0answers
23 views
WebAPI Versioning practice - Common version to all controllers
I am using Microsoft.AspNet.WebApi.Versioning for versioning my WebAPI project.
I already used version through the header with CustomControllerSelector class. After learning this package, I am ...
1
vote
1answer
79 views
Am I making API creation difficult when it comes to authentication?
I know the sites are not geared for recommendations so I am hoping to pose this question in a way that doesn't ask for recommendations. Questions comments are welcome.
I am just getting involved in ...
0
votes
0answers
16 views
Keep sync Authentication Server user profile with App Server best practices
I have two servers first one is Authentication Server that handles refresh token, AccessToken and external login. On external login, I create user and store profile information like first name and ...
2
votes
6answers
226 views
Difference between REST & HTTP REST implementations
REST principles are described here:
https://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm#sec_5_2
https://en.wikipedia.org/wiki/Representational_state_transfer#...
3
votes
2answers
71 views
Approach for storing lots of data of unknown type in database
I have an web app to which external applications can be connected to send their data. This is for telemetry purposes.
The web app is not controlling what kind of telemetry data is sent to it - it can ...
-1
votes
1answer
89 views
Is it good idea to set custom-defined getter and setter in c#?
I tried this way to define custom defined property but I wonder how to handle if any of the dependent properties have null value.
public class ObtainedMarksDetail
{
private decimal? ...
-3
votes
1answer
155 views
When designing a web application with Vue.js and ASP.NET Core, is ASP.NET solely for the API?
When creating a web application from scratch with ASP.NET MVC Core (using Visual Studio 2017) and using Vue.js, is the MVC Core part of the application solely for the API? What other function would ...
1
vote
1answer
60 views
How to remove code duplication in Web API versioning
I'm working with ASP.NET core web API project, where I have 8 controllers, multiple DTOs being used for request and response and mappers to map models(also used in the web app) with DTOs.
Recently, ...
2
votes
1answer
121 views
Calling executables from an ASP.NET WebAPI
I have an Angular application with a table, and I'm considering having the console application take the name of C# programs that the user can run.
I was thinking of passing the name or code of the ...
-1
votes
1answer
73 views
Any solution for scheduling a “high volume traffic” mode on API?
I have been wondering if there is any way to design and develop a mechanism for a REST API for scheduling some sort of "high volume" traffic so it does not conflict with normal rate-limiting. This ...
2
votes
4answers
240 views
C# class naming convention for a single item in the item list [closed]
In my C# project, I have a domain class named 'User'. this class will contain user's id, firstname, last name, DoB, home address, phone, etc. And we also have a typical REST web api (i.e. api/users) ...
0
votes
1answer
185 views
Mediator pattern across web API
What are your thoughts on mediator pattern being used from a client and across a web api?, this means:
Command definitions are shared between the client and api.
Web api exposes only one ...
0
votes
1answer
70 views
Best route naming convention when a RESTful GET needs to be a POST
I have a REST API that has been built on top (in front of) a legacy system, to allow 3rd parties of various platforms to interact with the system.
Most of the time, I can define a resource and create ...
3
votes
1answer
126 views
Best practice for REST result payload when field may have single or multiple values
I Have a REST API endpoint where the caller can supply some optional filters for the results.
GET api/inventory
For example, an object member of a GET request may look like the following
{
"...
0
votes
1answer
102 views
How to Redesign and scale legacy MVC application
I’m working with legacy web app for managing an animal shelter which need to be rearchitected/redesign, so it can scale and be possible to deploy in a central location.
Currently it's physically ...
-1
votes
4answers
118 views
When streaming JSON to end users, should each buffer be standalone JSON?
If you were streaming JSON to the end user, and every "buffer" of response was in the format of, for instance...
{ "something": "here", "other": 1}
You'd be in a spot where the entire stream ...
0
votes
0answers
36 views
Choice between PUT and a separate request for each change for CRUD-based UI
I'm making an HTTP API for ASP.NET Core Identity.
Basically what I want is a remote version of this: https://docs.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.identity.usermanager-1?view=...
1
vote
1answer
147 views
Repository pattern, call another API that updates a SOR's from service or repository class?
We are working on API's that call other API's that will inevitably retrieves/update a system of record like an SQL, MySQL or other database. Sometimes we'll have 3/4 layers of API's before the SOR is ...
-1
votes
1answer
559 views
Creating a mobile app based on the ASP.NET Core website
Coming from Desktop development, I'm in the middle of my very first web project (as a small side/learning-project). I'm using ASP.NET Core 2. I'm already thinking about going mobile too.
What are my ...
0
votes
1answer
219 views
Time-based Task scheduler engine
I am working on an enterprise level application. I have an event table in the database. I need to update my events' states in the database on a precise date and time. There may be 200 milliseconds ...
27
votes
5answers
9k views
Should I check if something exists in the db and fail fast or wait for db exception
Having two classes:
public class Parent
{
public int Id { get; set; }
public int ChildId { get; set; }
}
public class Child { ... }
When assigning ChildId to Parent should I check first if ...
3
votes
2answers
113 views
How to safeguard a COTS REST API with on-premise servers for approved client apps only?
Goal: Prevent unauthorized 'clone' apps from using REST API-based solutions where the customers manage their own servers and services instead of the vendor doing so (database, resource, and identity). ...
-2
votes
1answer
46 views
Should API also authenticate users from front end app?
I am building an API using Laravel and am looking at using Laravel/Passport for authentication - but I am struggling with a design decision.
The API will be consumed by multiple other applications / ...
-1
votes
1answer
57 views
Updating entity with REST
I'm looking for the "Holy Grail" (best practise) of how to update an entity with REST?
There are three main approaches I've found so far:
Always send full entity, regardless what has been changed ...
4
votes
3answers
808 views
Mapping API models(DTOs) to rich domain models
How to implement HTTP's PUT that works with child collections when using DDD's rich domain models?
Let's say we've got an aggregate root with a nicely encapsulated collection of items:
(I omitted ...
0
votes
1answer
177 views
Dealing with child collections updates in Web API
Let's take some classic enterprise example: Order and OrderItem
public class Order
{
public Guid Id { get; set; }
public ICollection<OrderItem> Items { get; set; }
}
public class ...
4
votes
2answers
3k views
Best practice for REST API call with many parameters
I have a REST API with GETs operations which receive a (long) list of parameters (8 parameters, for example). The aim of this operation is to search and filter elements.
Which is the best practice to ...
2
votes
3answers
563 views
Designing a REST API with resource relationships?
I'm working to design a REST API to be consumed by a React SPA.
The client-side of the SPA queries data about a relationship between two entities: Team and Player where Teams have many Players and ...
2
votes
1answer
211 views
Web application with relational database - best practice?
I am currently designing a web application which is pretty similar to Twitter but with some unique features for my company.
Technologies are Vue2, Spark framework and PostgreSQL.
I am trying to ...
0
votes
1answer
58 views
Strategy for ensuring consistency when integrating using an API?
How do I ensure consistency between two separate systems which store and maintain the same set of data, when the method of communication between them is REST APIs and webhooks? Is it possible?
I find ...
