정보기술-서비스 지향 아키텍처-Open API 서비스 인터페이스 명세 작성 지침
信息技术面向服务的体系结构开放API服务接口规范指南
发布日期:
2012-12-28
该标准提供了服务接口明细编制指南,以便为希望利用Open API服务的服务用户(或开发人员)提供可以理解的服务的接口明细。该标准提供了编写服务接口清单的标准,使服务提供者能够一致地描述服务的接口,并使服务使用者能够了解服务的更准确信息。一般的简单对象访问协议(SOAP:Simple Object Access Protocol)/REST(REpresentational State Transfer)方式的Web服务描述语言(WSDL:Web服务描述语言)是程序为了识别而描述的,因此很难让人看到WSDL,了解服务的功能和目的。该标准中给出的服务接口明细是为了弥补这些WSDL的弱点,让想要利用服务的服务使用者(或开发者)能够理解的接口内容。该标准提供了编写服务接口清单的标准,使服务提供者能够一致地描述服务的接口,并使服务使用者能够更准确地了解服务的信息。如果服务提供者应用于服务的服务接口技术类型为SOAP、REST,则应与WSDL一起描述服务接口明细。但RSS(Really Simple Syndition)、Atom只描述服务接口明细。
服务提供者必须维护和管理最新的接口详细信息,并由服务使用者通过可访问的服务注册存储库或单独的方法向服务使用者提供。
이 표준은 Open API 서비스를 활용하고자 하는 서비스 사용자(혹은 개발자)인 사람이 이해할 수 있 는 서비스에 대한 인터페이스 명세를 제공할 수 있도록 서비스 인터페이스 명세 작성 지침을 제공한 다. 이 표준에서는 서비스 인터페이스 명세를 작성할 수 있는 기준을 제공하여, 서비스 제공자가 서 비스의 인터페이스를 일관성 있게 설명할 수 있도록 하고, 서비스 사용자가 서비스에 대해 보다 정 확한 정보를 파악할 수 있도록 한다. 일반적인 단순 객체 접근 프로토콜(SOAP: Simple Object Access Protocol)/REST(REpresentational State Transfer) 방식의 웹서비스 기술 언어(WSDL: Web Services Description Language)는 프로그램 이 인식하기 위해 기술되므로 사람이 WSDL을 보고 서비스의 기능과 목적을 파악하기는 어렵다. 이 표 준에서 제시하고 있는 서비스 인터페이스 명세는 이러한 WSDL의 약점을 보완하기 위해서 서비스를 활용하고자 하는 서비스 사용자(혹은 개발자)인 사람이 이해할 수 있도록 인터페이스 내용을 기술한 것이다. 이 표준에서는 서비스 인터페이스 명세를 작성할 수 있는 기준을 제공하여, 서비스 제공자가 서비스 의 인터페이스를 일관성 있게 설명할 수 있도록 하고, 서비스 사용자가 서비스에 대해 보다 정확한 정보를 파악할 수 있도록 한다. 서비스 제공자는 서비스에 적용된 서비스 인터페이스 기술유형이 SOAP, REST인 경우 WSDL과 더 불어 서비스 인터페이스 명세를 기술하여야 한다. 다만 RSS(Really Simple Syndication), Atom은 서비스 인터페이스 명세만을 기술한다. 서비스 제공자는 가장 최신의 인터페이스 명세 정보를 유지, 관리하여야 하고 서비스 사용자가 접근 가능한 서비스 등록저장소나 별도의 방법을 통해 서비스 사용자에게 제공하여야 한다.