Say you have a REST API endpoint like POST /move-money which transfers money from your main account to a savings pot. There are three path para..
Tag : api-design
When designing types and their APIs, I try to adhere to these simple principles (which vaguely feel like one general principle to me) as much as fea..
I need to design the architecture for a website for registering for credit-based courses for students. Each semester, students can register for a maximum of 30 credits. Courses can be mandatory or elective, and may have one or more prerequisite courses (if a prerequisite course has not been completed, the student cannot register for the subsequent co..
Just for some context, I am a CS student in my second-year who is working on a C++ desktop application (using the Qt framework) made by an engineering prof..
I have a HATEOAS API (in ASP.NET) with an endpoint:
POST /api/messages – to create a new message and it returns the location of a new m..
I have a “Games” API with retrieves video game data from a large database.
The /games endpoint returns some very basic info about the game, such as the title, description..
I’m working with an API that uses OpenAPI for its schema documentation. However, there are certain fields in the request body that shouldn’t be visible to all consumers, for example, internalProperty: bool. These properties are crucial for some internal functionalities but aren’t documented in the public-facing s..
I have an endpoint in API 1 (my api) that queries API 2 (another companies api) to view and edit objects stored in API 2’s database. API 1 is essentially acting as a wrapper service around API 2, providing some extra function..
Suppose there is a primary resource “/accounts” which has Profile (name, national id, DOB), addresses and contacts(email, phones). I am considering them as sub-resources because they cannot exist without an account. To update them I am thinking two o..
Exactly as the name says, should smart pointers be exposed in a C++ librar..