100 days system design

100-days-system-design.md

100 days system design

References

• Software Architecture Guidelines

General Overview

1. Usecases

2. Constraints

3. Assumptions

4. Risks

Design Considerations

1. Goals

Functional requirements

• As a user, I want to do something

Non functional requirements

• Consistency - eventual consistency
• Security
• Persistency
• High Availability
• Latency - as low as possible

2. Dependencies

• Connect with an existing system

Overall System Architecture

1. Conceptual View

• Input: business requirements, actors and systems
• Output: System Overview, High Level Class Diagram
• Methodologies: Modules - object oriented analysis

2. Functional View

• Input: System Overview, Functional requirements
• Output: Usecase Diagrams

3. Logical View

• Input: Dataset, Usecase Diagrams
• Output: Dataflow Diagram, Database Schema diagram

4. Component View

5. Network View

6. Security View

...

Design Decisions

1. Conceptual View

FinanceData Component

2. Funtional View

FinanceData Component - Import

3. Logical View

Template

1. Funtional

Design

2. Non-Funtional

1. High Availability
2. Persistency
3. Consistency - eventual consistency
4. Latency - as low as possible

3. Capacity

4. High Level

It should be interactions between components in system. No need to be specific, eg: database type

Notes

• Login & Auth
• Solution validation is not

CAP

Consistency and Distributed System

Availability

2 phase commit

REST API Design Checklist Template

• General
• Refs
• Best Practice

What is REST API

• API : Application programming interface
• Representational state transfer

REST API là gì?

Một loạt các quy tắc được đặt ra khi thiết kế và lập trình cho các ứng dụng, nhằm mục đích thống nhất các thể hiện của trạng thái được truyền tải trong những ứng dụng này.

Trong thực tế, bạn có một ứng dụng quản lí trạng thái bật/tắt của các bóng đèn trong nhà. Thì trạng thái của từng bóng đèn sẽ được lưu lại và cho phép người dùng biết được trạng thái của bóng đèn hiện tại.

Khi xây dựng ứng dụng này, sẽ có 3 phần: ứng dụng phía người dùng, ứng dụng kết nối và xử lý các yêu cầu của người dùng, ứng dụng điều khiển bóng đèn trực tiếp.

Cơ chế hoạt động chính là : khi người dùng tương tác với ứng dụng( có thể là trang web/ mobile app ) thì nó sẽ gửi yêu cầu lên ứng dụng quản kết nối và xử lý yêu cầu, để ứng dụng trung gian này tương tác với ứng dụng xử lý việc bật/tắt của bóng đèn tương ứng. Đồng thời cho phép người dùng biết được trạng thái hiện tại của từng bóng đèn.

Chính vì điều đó REST API được ra đời, nó là các nguyên tắc thiết kế dữ liệu truyền tải giữa các ứng dụng

Vậy các quy tắc đó là gì, chúng ta sẽ tiếp tục tìm hiểu chi tiết bên dưới đây.

Testing

Data