乐趣区

关于api设计:我总结了一次-API-接口设计原则有这些

联合我多年在 API 行业摸爬滚打的教训,我总结了一下,API 接口设计准则有这几条:

  1. 接口设计应该简略易用,易于了解和应用;
  2. 接口设计应该反对多种格局,如 JSON、XML 等;
  3. 接口设计应该反对多种申请形式,如 GET、POST 等;
  4. 接口设计应该反对多种版本,以便于前期的扩大和降级;
  5. 接口设计应该思考安全性,如采纳 https 协定;
  6. 接口设计应该思考性能,如采纳缓存技术;
  7. 接口设计应该思考可扩展性,如采纳分布式架构;
  8. 接口设计应该思考可维护性,如采纳模块化的形式;
  9. 接口设计应该思考可测试性,如采纳单元测试的形式。

如果你日常会用到 api 管理工具的话,无妨看看我目前参加的这个开源我的项目,Postcat 开源的 API 管理工具 ,纯国产,收费的,主打插件生态,适宜中小团队以及集体开发者应用,有 API 相干的外围性能。

目前在 Github 上 3k star, 如果你感觉这个我的项目还不错的话,无妨点个 star 反对一下~

Github:
https://github.com/Postcatlab/postcat
Demo:
https://postcat.com/zh/?utm_source=sf&utm_campaign=xh&utm_con…

Postcat 外围性能:

  • API 文档治理:可视化 API 设计,生成 API 文档
  • API 测试:主动生成测试参数,主动生成测试用例,可视化数据编辑
  • 插件拓展:泛滥插件扩大产品性能,打造属于你和团队的 API 开发平台
  • Mock:依据文档主动生成 Mock, 或创立自定义 Mock 满足简单场景
  • 团队合作:既能实现 API 分享也能能够创立云空间独特合作

Postcat 劣势:

  • 免登录即可测试:省去繁琐的验证登录的操作
  • 界面简洁:没有冗余的性能与简单选项
  • 收费:中小团队以及集体应用
  • 丰盛的插件:反对数据迁徙 (postman\apifox\apipost 等)、主题、API 平安等高达 30 款插件
  • 国产:能更好的了解国内用户的需要,与开发团队沟通无障碍
  • 欠缺的用户文档:跟着操作就能疾速上手
退出移动版