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
1
vote
1answer
29 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
42 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
77 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.
...
1
vote
1answer
112 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
72 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
74 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
15 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
221 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
69 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
87 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
98 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
39 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
69 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
70 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
216 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
110 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
66 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
125 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
93 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
71 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
254 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
180 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 ...
26
votes
5answers
7k 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
107 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
42 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
46 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
628 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
115 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
1k 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
326 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
153 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
54 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 ...
0
votes
0answers
323 views
Decoupling logic and data access from service layer
I would appreciate some feedback on the following design choices, also whether the IDisposable pattern I'm using is good in this case. I've tried to follow what Microsoft suggests when implementing ...
1
vote
2answers
663 views
Stateful authentication in REST API using tokens
I have recently started on a project involving a REST API. The API requires authentication with requirements for administrators to be able to view logged in users and to be able to revoke specific ...
0
votes
0answers
40 views
Are REST Resources and GraphQL Object Types conceptually equal?
I'm in the process of outlining the intended business logic of a web service. At this point, I'm not too concerned with implementation details. On the contrary, I'm looking for ways to abstract them ...
2
votes
1answer
152 views
Web API: REST-ish pattern for flexible querying of time-series data
I'm working on a product that exposes a RESTful API to interact with system entities (the usual CRUD), which works very well.
In addition to CRUD, we've recently encountered a need to expose the ...
1
vote
2answers
293 views
What happen if we never dispose HttpClient, .Net C#?
I'm working on a windows service. Code of windows service is very simple but it has a strange manner!
In windows service I should call a WebApi each 20 seconds and save the result in a SQL Database
I'...
0
votes
1answer
66 views
Reasons why the ASP.NET Web API Controller cache ignores dynamic assemblies
I've been reading about how ASP.NET Web API looks up the locations of controllers in assemblies, and ways to dynamically add a new assembly to look in. So far this has all been fine, except I've ...
0
votes
1answer
112 views
API gateway for web-fronted applications, is it worth it?
So am in the process of developing a new application and am welling to adopt a micro-services based architecture (am new to that).
The problem is that the application will be exposed to the final ...
-1
votes
1answer
40 views
Advice on accessing an API Service
I have a requirement to validate a data field (a reference number for payments) in our finance system by connecting to one of our vendor's API services. The finance system does not have the ...
-3
votes
1answer
93 views
ASP.Net WebAPI or Node JS?
I wish to write RESTful web services which can be consumed from a Web Application and a mobile application. The database is designed in SQL Server 2012.
I estimate that there won't be more than 1000 ...
-1
votes
2answers
55 views
What should be the REST API (URL) for a user to be assigned to multiple territories
In our application we have a user who can be assigned multiple territories.
What is the best way to expose the REST API?
Should it be as :
[POST] www.xyz.com/Territory/User
OR
[POST] www.xyz.com/...
0
votes
2answers
129 views
Handling a limited resource in rest WEB API 2
I have developed a restful WEB API 2 (C#, .NET 4.7) for an internal integration project. In my API's backend, I need to use a vendor's dll in order to process the provided input.
The vendor's dll is ...
1
vote
3answers
115 views
How use a REST interaface for implementing tasks commands on my Web API?
I'm creating a Web API with a lot of REST Resources.
My service also have some tasks which should be started on demand. for instance "Start sending emails".
For now I do have a specific URL which I ...
0
votes
2answers
831 views
RESTful API Relationships
Lets say we are making an API with two resources: Author and Book where books can have many authors and authors can have many books.
So we design the REST api like so:
/books
/books/:id
/books/:id/...
-2
votes
1answer
91 views
When to use a proper API and when to use session state?
I was looking at this documentation.
https://laravel.com/docs/5.6/passport
it is quite long and I asked myself, why would one use this, over just a normal login where you store necessary information ...
2
votes
2answers
104 views
Should a POST endpoint in a REST API allow the inclusion of related resources?
Given the following REST endpoints:
(GET, POST) /api/v2/employer
(GET) /api/v2/employer/{id}
(GET, POST) /api/v2/employer/{id}/employees
Should a consumer of this API have the ability to ...
