Definition: Architecture Decision Record from where you should specialise the ADR SBBs regarding the API Design
Source: ISO/IEC/IEEE 42010:2022
Source reference:
https://www.iso.org/standard/74393.html
Additional information: API design is a crucial aspect of IT architecture decision-making, as it determines how different software systems and applications communicate with each other. A well-designed API can improve the efficiency and effectiveness of software development, as it allows developers to easily integrate different systems and functionalities. On the other hand, a poorly designed API can lead to compatibility issues, security vulnerabilities, and other problems that can hinder the development process. Therefore, IT architects must carefully consider the design of APIs when making decisions about software development and integration. This includes factors such as the format and structure of the API, the security measures in place, and the ease of use for developers.
Example: One example of the application of the Directive 2014/24/EU is in the procurement of construction services for a new public building. The directive requires that the procurement process be open, transparent, and non-discriminatory, with equal opportunities for all potential bidders. The contracting authority must publish a notice of the procurement in the Official Journal of the European Union, and provide all relevant information to interested parties. The directive also requires that the contracting authority evaluate bids based on objective criteria, and award the contract to the most economically advantageous tender. This ensures that public funds are used efficiently and effectively, and that the public receives high-quality services at a fair price.
LOST view: Digital Solution Architecture Decisions Catalogue view
Identifier:
http://data.europa.eu/dr8/egovera/APIDesignGoal
EIRA traceability: eira:DigitalSolutionArchitectureDecisionGoal
ABB name: egovera:APIDesignGoal
EIRA concept: eira:ArchitectureBuildingBlock
Last modification: 2023-06-15
dct:identifier: ADR-20230515180947613
dct:title: Architecture Decision Record about API Design
eira:adr_context: The context explains why we need to make a decision. It also describes the alternatives along with the pros and cons.
eira:adr_decision: The decision describes the justification for why the particular solution was accepted. It has more emphasis on the why rather than the how.
eira:adr_status: [Proposed (under review)|Accepted (approved and ready for implementation)|Superseded (superseded by another decision)]
eira:adr_consecuences: The consequences section contains information about the overall impact of an architectural decision. Every decision has trade-offs. That’s why it’s crucial to include the analysis to provide a clear picture.