API设计原则总结

来源:互联网 发布:人工智能的好处 编辑:程序博客网 时间:2024/05/22 01:48

最近本人重构公司一个web API组件,总结如下几条原则:

  • 参数比较简单的情况下,尽量放在URL里面,方便使用; 参数比价复杂,或者需要加密,则放在 body 里面;
  • 尽量按照REST风格来,按照资源进行组织;
  • 老的接口,如果不符合风格,如果没有人使用,或者只是内部人用,则删除,换新的; 通知相关人员换到新接口;
  • 如果使用比较广泛,则保留;
  • 如果有使用场景,也保留。
1 0