API本质上是封装和抽象功能的、并且只公开一个用于访问该功能的接口。API开发人员常常没有意识到其中有多少功能没有公开,这会让使用者无法更好的理解、使用API。

如果发布的API难以集成、不遵循任何标准或不适当的标准,则开发人员使用该系统会非常吃力。确定要使用哪种API标准非常重要,因为每种标准都针对特定的受众。如果需要支持最大数量的用户,可以使用一个非常简单的、不需要太多开销的API标准,例如RESTful API。REST标准相当宽松。最好的方法是各个API之间保持一致。

遵循用于身份验证的通用API标准(例如OpenID,OAuth和SAML)可以使开发人员和非开发人员客户更容易地使用API。但是,如果不为用户处理身份验证,请使用更简单的基于HTTP或基于令牌的身份验证,而不是主要用于身份验证的OpenID,OAuth或SAML。

此外,提供一个可记录自身信息的API文档,对开发人员来说是有益的,它可以让开发人员快速的了解API的作用。例如您可以将API规范等信息保存在Eolinker中。Eolinker是一个统一接口管理平台,可快速导入API并生成API文档。当API文档完善后,还需要围绕它们进行一些良好的测试。 使用地址:www.eolinker.com

如果你想让你的API易于使用和理解,你真的必须把它文档化。当API文档规范化且有较高的可读性,则API管理会变得更加简单,并大大提高工作效率。

如何简单的管理API相关推荐

  1. Spring3.1新属性管理API:PropertySource、Environment、Profile

    2019独角兽企业重金招聘Python工程师标准>>> Spring3.1提供了新的属性管理API,而且功能非常强大且很完善,对于一些属性配置信息都应该使用新的API来管理.虽然现在 ...

  2. Asp.net用户管理API的应用(上)

    Asp.net官方标准控件实现用户的管理,虽然简单,但控件封装性很强,开发人员不能明白做了什么样的调用,还用别一方面,标准控件的使用,很大程度上限制了程序的可变性.如果自开发一整套用户管理系统,可行, ...

  3. 启动服务错误5拒绝访问_【Go API 开发实战 5】基础1:启动一个最简单的 RESTful API 服务器...

    启动一个最简单的 RESTful API 服务器 本节核心内容 启动一个最简单的 RESTful API 服务器 设置 HTTP Header API 服务器健康检查和状态查询 编译并测试 API 本 ...

  4. multipartfile前端怎么传_前端那些事如何更好管理 Api 接口

    ❝ 前沿:自从前端和后端分家之后,前后端接口对接就成为了家常,"谁"也离不开谁,而对接接口的过程就离不开接口文档,比较主流就是Swagger(强大的API文档工具),当然今天它不是 ...

  5. 【Go API 开发实战 5】基础1:启动一个最简单的 RESTful API 服务器

    本节核心内容 启动一个最简单的 RESTful API 服务器 设置 HTTP Header API 服务器健康检查和状态查询 编译并测试 API 本小节源码下载路径:demo01 可先下载源码到本地 ...

  6. www.how2j.com_HOW-TO:快速开始使用Spring 4.0,以构建简单的REST-Like API(演练)

    www.how2j.com HOW-TO:快速开始使用Spring 4.0,以构建简单的REST-Like API(演练) 关于使用Spring MVC创建Web API的另一篇教程. 不太复杂. 只 ...

  7. 如何:从Spring 4.0快速入门以构建简单的REST-Like API(演练)

    如何:从Spring 4.0快速入门以构建简单的REST-Like API(演练) 关于使用Spring MVC创建Web API的另一篇教程. 不太复杂. 只是一个演练. 生成的应用程序将提供简单的 ...

  8. 使用Webtask.io创建一个简单的REST API端点

    by ismapro 由ismapro 使用Webtask.io创建一个简单的REST API端点 (Create a simple REST API endpoint using Webtask.i ...

  9. Kong API Gateway 管理API详解

    Kong API Gateway 管理API详解 2018-09-25 /  Linuxops 版权说明:本文为博主原创,如果转载请注明来源.作为学习笔记,不能保证所有知识点是完全正确以及表达无误,用 ...

最新文章

  1. Nginx-1.9.8推出的切片模块
  2. php获取字符串扩展,PHP7扩展开发之字符串处理
  3. 蚊子132 各方人员都“照顾”到位则业务会很乐观
  4. 十天冲刺开发第一天个人工作总结
  5. 实时获取麦克风语音信号
  6. SpringBoot 优雅停止服务的几种方法
  7. python怎么读_锋哥告诉你Python怎么读
  8. 数据库基础知识——互动百科
  9. linux测试进程内存,怎么测试进程运行时的内存用量
  10. RedHat系统的Yum安装
  11. dos盘启动计算机,u盘dos启动盘怎么制作 u盘dos启动盘制作步骤【详细介绍】
  12. word2007自动生成目录
  13. java怎么设置序号_Java 添加Word项目符号、编号列表
  14. python中一元二次方程的虚根_一元二次方程的概念和习题(老师用)
  15. 一个官网很详细的富文本编辑器
  16. HTML5 开发工具
  17. excel表格如何打斜杠
  18. 使用Umi SSR 报错 Warning: Did not expect server HTML to contain a <div> in <div>.
  19. IMX6ULL系列学习记录-sii902x移植篇
  20. Android Hawk数据库的源码解析,Github开源项目,基于SharedPreferences的的存储框架

热门文章

  1. source insight4.0使用教程
  2. magento 赠品_免费赠品:10个高质量的夏季刻字
  3. 日常运维工作的知识体系
  4. 如何用计算机求极限,计算器的极限_500字
  5. 吾日三省吾身:三种光
  6. netcat(NC)学习笔记-nc命令基础解释以及基础使用--包含使用nc获取shell
  7. 20071020--高桥
  8. 【芝麻信用对接】欺诈信息验证
  9. 轴承座冲压模具设计(论文+CAD图纸+开题报告+任务书)
  10. 从未谋面只闻其名——缅怀张孝祥老师!