如何解决API 设计:移除未使用的 CRUD 服务
我目前是一个 Web 服务的支持者,该服务拥有多个支持 CRUD 操作的资源。我发现对于某些资源,其中一些操作(但不是同时所有四个操作)未被消费者使用。
以下哪个是首选?
- 移除未使用的端点,因为未使用的代码会导致维护成本和 YAGNI。
- 保持 API 原样,因为更重要的是拥有完整的操作集(GET、PUT、POST、DELETE),这使得处理资源更加愉快,如果它只是一些手动测试。
解决方法
在我看来,如果您认为未使用的方法会产生错误,请删除或注释代码。您可以在需要时查看这些内容。仅保留您需要的资源。
,拥有完整的操作集(GET、PUT、POST、DELETE)更重要
拥有一套完整的操作并不是特别重要。实际上,HTTP specification 中记录了大多数资源不支持 DELETE
允许使用 DELETE 方法的资源相对较少——它的主要用途是远程创作环境,用户对其效果有一定的指导。
如果只是为了一些手动测试。
测试和运营是支持不直接增加收入的资源和运营的完全正当理由。
还有:cool URI don't change。向后兼容是 REST 架构风格中的一个重要思想,不应无缘无故地打破消费者对网络的看法。
在停止对某项操作的支持时需要注意的一件事是了解客户是否因为不需要该操作而不使用该操作,或者他们是否因为需要的情况而不使用该操作它不经常出现。
,对此很难给出一般性答案,但我通常会删除未使用且没有计划的代码。
更多的代码是错误和安全问题的更大表面积。维护代码不是免费的。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。