设计 API 时的最佳实践

发布于 2024-09-27 22:49:08 字数 49 浏览 3 评论 0原文

我正在为我正在编写的系统设计一个内部 API。 API 设计中需要考虑哪些最佳实践?

I am designing an internal API for a system I am writing. What are some best practises in API Design to think about?

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(3

看海 2024-10-04 22:49:08

这些示例是用 Java 编写的,但提示适用于任何语言。

如何设计良好的 API 及其重要性

The examples are in Java but the hints apply to any language.

How To Design A Good API And Why It Matters

蓝眼泪 2024-10-04 22:49:08

测试驱动开发。

TDD 将为您的设计提供信息,因为它会提示您提出诸如“我需要这个做什么”之类的问题,并且它使您在进行修订时更容易充满信心地进行重构。它还鼓励让事情尽可能简单,这总是一件好事。

Test Driven Development.

TDD will inform your design because it prompts you to ask questions like 'what do I need this to do' and it makes it easier for you to refactor with confidence, as you go thru your revisions. It also encourages making things as simple as possible, which is always a good thing.

梦里人 2024-10-04 22:49:08

请记住,API 是一个用户界面。我尝试专注于

  • 做好一件事,
  • 保持有用的功率重量比,
  • 避免神秘的名称,并
  • 通过测试和有效的文档明确指定行为

Just remember that an API is a user interface. I try to focus on

  • doing one thing well,
  • maintaining a useful power-to-weight ratio,
  • avoiding cryptic names, and
  • explicitly specifying behavior via tests and effective documentation
~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文