how to design a good api and why it matters

Posted 2020-09-07 soul.stone

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了how to design a good api and why it matters相关的知识，希望对你有一定的参考价值。

Characteristics of a Good API

? Easy to learn

? Easy to use, even without documentation

? Hard to misuse

? Easy to read and maintain code that uses it

? Sufficiently powerful to satisfy requirements

? Easy to extend

? Appropriate to audience

General Principles

API Should Do One Thing and Do it Well

API Should Be As Small As Possible But No Smaller

Implementation Should Not Impact API

Minimize Accessibility of Everything

Names Matter–API is a Little Language

Documentation Matters

Effects of API Design Decisions on Performance are Real and Permanent

API Must Coexist Peacefully with Platform

以上是关于how to design a good api and why it matters的主要内容，如果未能解决你的问题，请参考以下文章