Arik Chakma
274082fd77
* refactor: clean to roadmap content * refactor: move shared helpers into scripts/lib
15 lines
835 B
Markdown
15 lines
835 B
Markdown
# Questions to Ask
|
|
|
|
- API as small as possible, as large as needed?
|
|
- Is there one way of doing one thing, not multiple ones?
|
|
- Is it consistent, does it follow the principle of least surprise?
|
|
- Clean split of API/internals without internals leaking into the API?
|
|
- Are there no breaking changes to user-facing parts (API classes, configuration, metrics, log formats, etc)?
|
|
- Is a new API generally useful and not overly specific to a single use case?
|
|
|
|
Learn more from the following resources:
|
|
|
|
- [@article@API Design Best Practices Guide - Fern](https://buildwithfern.com/post/api-design-best-practices-guide)
|
|
- [@article@RESTful API Resource Naming](https://restfulapi.net/resource-naming/)
|
|
- [@article@Web API Design Best Practices - Microsoft Azure](https://learn.microsoft.com/en-us/azure/architecture/best-practices/api-design)
|