新手指引:发布接口服务

适用场景:

  • 您的系统要开放HTTP接口,希望发布到平台的服务目录中,让第三方可以方便的查阅和测试接口
  • 您的系统要开放HTTP接口,希望通过平台来集中管理接口的部署环境、版本、文档、SDK等信息
  • 您的系统要开放HTTP接口,希望通过平台来实现用户认证、权限控制、日志分析和监控等功能

不适用场景:

  • 开放的接口不能通过HTTP(s)协议访问

接口服务,在平台中指通过HTTP(s)协议访问的Web API(简称API),API发布到平台有以下几个优点:

  • 统一的API门户,使用者可以集中在一个服务目录中找到想要的API
  • 统一的API授权,使用者申请API、API的访问授权、API的访问控制都由平台完成
  • 文档和SDK生成,如果API的符合约定的规范,平台可以自动生成API的文档和SDK
  • 调用日志查看,平台接管了所有API的调用,可以通过平台查看调用日志,分析问题

    如果API符合平台日志规范,还可以在一次调用中查看到更详细的信息,如慢SQL

  • API实时监控告警

详细的接入过程请查看API接入章节。