API Design and Develop Cheatsheet
Restful API Design and Develop Guidelines
Restful API Design criteria
Database Design Criteria
- [x] Data size
- [x] Reads & Writes
- [x] Number of operations
- [x] Operations per second
- [x] Required latency
- [x] Pinning attribute queries
- [x] Durability
Identify Workload
Basic steps to design and develop a Restful API
1. High Level Design
- Break system into components/modules
2. Designing and Seeding the Database
- Read and analyze requirements, define system actors: entity + action + relationship to create your database schema
- Design your data constraints: data types, data size, value restrictions
- Optimize the basic actions: Read, Find with/without Filter, Insert, Update, Delete, Bulk Actions: Insert, Update, Delete
- Make decision to choose DB Engine
- Insert your seeding data
- Test the output schema