Code Architecture, Standards & Best practices

I will take one session on Architecture: 1. What is code architecture and why it’s necessary and why it will be mandatory from now on 2. What is system/logical architecture and how it is different from physical architecture 3. What is infrastructure or physical architecture (we know or use this concept very well)

Hence, when we design RESTful API, we should refer to maturity model of RESTful. https://dzone.com/articles/api-design-principle

In object-oriented programming, the open–closed principle states “software entities (classes, modules, functions, etc.) should be open for extension, but closed for modification”;[1] that is, such an entity can allow its behaviour to be extended without modifying its source code.

https://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api

Help and Documentation “Even though it is better if the system can be used without documentation, it may be necessary to provide help and documentation. Any such information should be easy to search, focused on the user’s task, list concrete steps to be carried out, and not be too large.” — Nielsen

Help Users Recognize, Diagnose, and Recover from Errors “Error messages should be expressed in plain language (no codes), precisely indicate the problem, and constructively suggest a solution.” — Nielsen

should provide an interface that is easy to use for the beginner, along with optional controls aimed at improving efficiency.

Flexibility and Efficiency of Use “Accelerators — unseen by the novice user — may often speed up the interaction for the expert user such that the system can cater to both inexperienced and experienced users. Allow users to tailor frequent actions.” — Nielsen

Error Prevention “Even better than good error messages is a careful design which prevents a problem from occurring in the first place.” — Nielsen

“The system should speak the users’ language, with words, phrases and concepts familiar to the user, rather than system-oriented terms. Follow real-world conventions, making information appear in a natural and logical order.” — Nielsen

“Program to an interface, not an implementation.”

“Favor object composition over class inheritance.”

There are OS hardening practices and script when it comes to security so keep that as a part of your infra provisioning script

check sentry for performance monitoring

ELK monitoring along with wazuah for security is good, sms or email alerts are enough

Single tenant approach needs to be ready now

Continuous or daily VAPT, stress testing, automation tests to run on stage servers

Explore micro services architecture