-
Notifications
You must be signed in to change notification settings - Fork 0
Backend: API Design Guidelines
Brian Tkatch edited this page Oct 3, 2025
·
3 revisions
- Avoid redundant words, brand names, or trademarks
- Avoid acronyms unless they are universally understood (like ID)
- Use the plural form for endpoints that can return more than one resource (like
/stations) - Use the single form for endpoints that return details about one resource (like
/stations/1) - Use
lowerCamelCasefor all endpoints and JSON property names. - Acronyms should be cased like normal words, not all uppercase (like
idoruserId, notIDoruserID)
Simulation Meeting Minutes
Frontend Meeting Minutes
Backend Meeting Minutes
Risks
User Consent and End-User License Agreement
Legal and Ethical Issues
Economic
Budget
Personas
Diversity Statement
Overall Architecture and Class Diagrams
Infrastructure and Tools
Name Conventions
Testing Plan and Continuous Integration
Security
Performance
Deployment Plan and Infrastructure
Missing Knowledge and Independent Learning
Glossary
Mockups
UI Evolution
Logging
Metrics
VeloSim Observability & Performance Insights
User Manual
Usability Tests