[webMethods][OData] OData Service 생성 가이드

• References
• OData 란
• OData 데이터 모델 (Microsoft)
• OData Document (Odata Version 2.0)
• OData Basic Tutorial (호출 예제)
• Service Development Help (webMethods)

• OData (Open Data Protocol)
• RESTful 웹 서비스를 위한 프로토콜로 클라이언트와 서버 간 데이터 통신을 위한 표준화 된 프로토콜
• Microsoft가 개발한 프로토콜로 다양한 플랫폼과 언어에서 사용할 수 있도록 설계
• Query를 통해 웹 상에서 손쉽게 데이터를 조회 수정 등을 (CRUD) 할 수 있도록 주고 받는 웹 프로토콜 (SQL for Web)
• HTTP(S)를 통해 통신하며, XML 또는 JSON 과 같은 표준 데이터 형식을 지원
• OData Data Version 4.0 까지 공개 되었지만 v2.0 표준 (2023 기준)

• OData 의 엔티티 데이터 모델 (EDM)
  

<?xml version="1.0"?> 
<service xmlns:atom="http://www.w3.org/2005/Atom" xmlns:app="http://www.w3.org/2007/app" xmlns="http://www.w3.org/2007/app" xml:base="https://services.odata.org/V2/Northwind/Northwind.svc/"> 
  <workspace> 
    <atom:title>Default</atom:title> 
    <collection href="Categories"> 
      <atom:title>Categories</atom:title> 
    </collection> 
    <collection href="CustomerDemographics"> 
      <atom:title>CustomerDemographics</atom:title> 
    </collection> 
    <collection href="Customers"> 
      <atom:title>Customers</atom:title> 
    </collection> 
    <collection href="Employees"> 
      <atom:title>Employees</atom:title> 
    </collection> 
....

• Collection (≈ Entity Sets) 은 Entity 를 이루는 하나 의 단위
• 각 데이터 모델의 Entry Points 를 제공

<?xml version="1.0" encoding="utf-8"?> 
<feed xml:base="https://services.odata.org/Northwind/Northwind.svc/" xmlns="http://www.w3.org/2005/Atom" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata"> 
    <id>https://services.odata.org/Northwind/Northwind.svc/Customers</id> 
    <title type="text">Customers</title> 
    <updated>2020-05-12T12:04:37Z</updated> 
    <link rel="self" title="Customers" href="Customers" /> 
    <entry> 
        <id>https://services.odata.org/Northwind/Northwind.svc/Customers('ALFKI')</id> 
        <category term="NorthwindModel.Customer" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" /> 
        <link rel="edit" title="Customer" href="Customers('ALFKI')" /> 
        <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Orders" type="application/atom+xml;type=feed" title="Orders" href="Customers('ALFKI')/Orders" /> 
        <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/CustomerDemographics" type="application/atom+xml;type=feed" title="CustomerDemographics" href="Customers('ALFKI')/CustomerDemographics" /> 
        <title /> 
        <updated>2020-05-12T12:04:37Z</updated> 
        <author> 
            <name /> 
        </author> 
        <content type="application/xml"> 
            <m:properties> 
                <d:CustomerID>ALFKI</d:CustomerID> 
                <d:CompanyName>Alfreds Futterkiste</d:CompanyName> 
                <d:ContactName>Maria Anders</d:ContactName> 
                <d:ContactTitle>Sales Representative</d:ContactTitle> 
                <d:Address>Obere Str. 57</d:Address> 
                <d:City>Berlin</d:City> 
                <d:Region m:null="true" /> 
                <d:PostalCode>12209</d:PostalCode> 
                <d:Country>Germany</d:Country> 
                <d:Phone>030-0074321</d:Phone> 
                <d:Fax>030-0076545</d:Fax> 
            </m:properties> 
        </content> 
    </entry> 
    <entry> 
        <id>https://services.odata.org/Northwind/Northwind.svc/Customers('ANATR')</id> 
        <category term="NorthwindModel.Customer" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" /> 
        <link rel="edit" title="Customer" href="Customers('ANATR')" /> 
        <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Orders" type="application/atom+xml;type=feed" title="Orders" href="Customers('ANATR')/Orders" /> 
        <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/CustomerDemographics" type="application/atom+xml;type=feed" title="CustomerDemographics" href="Customers('ANATR')/CustomerDemographics" /> 
        <title /> 
        <updated>2020-05-12T12:04:37Z</updated> 
        <author> 
            <name /> 
        </author> 
        <content type="application/xml"> 
            <m:properties> 
                <d:CustomerID>ANATR</d:CustomerID> 
                <d:CompanyName>Ana Trujillo Emparedados y helados</d:CompanyName> 
                <d:ContactName>Ana Trujillo</d:ContactName> 
                <d:ContactTitle>Owner</d:ContactTitle> 
                <d:Address>Avda. de la Constitución 2222</d:Address> 
                <d:City>México D.F.</d:City> 
                <d:Region m:null="true" /> 
                <d:PostalCode>05021</d:PostalCode> 
                <d:Country>Mexico</d:Country> 
                <d:Phone>(5) 555-4729</d:Phone> 
                <d:Fax>(5) 555-3745</d:Fax> 
            </m:properties> 
        </content> 
    </entry> 
... (중략)

• [GET] 호출 예시로 Entity Set 에 매핑 된 데이터를 로드 할 수 있음
• 호출 시 파라미터에 $format=json 을 입력하여 JSON 변환 된 응답 값 확인 가능

• webMethods OData Service 상세
  
  OData Service 생성 아이콘
  

• OData Service
• OData 엔티티 데이터 모델을 노출하는 서비스 (Entry Points)
• OData Service Provider로 외부에는 Entity Sets (Collection) 의 역할을 하는 서비스
• 생성 된 Service 내에서 Entity, Properties, Association 을 선언 하여 데이터 모델을 생성
• Empty OData Service / External Source Type 생성 지원 (v.10.15 기준)

• OData Elements

• Properties

• Associations

{ 
    "NAME": "testUser3", 
    "EMAIL": "test3@cudo.co.kr", 
    "PHONENUMBER": "testUser3" 
}

# Request Body 
{ 
  "ID": "2", 
  "Company": "CUDO2", 
  "Person": "SEO JI HOON", 
  "FullAddress": { 
    "Address1": "서초구 효령로 34길 4", 
    "Address2": "4층 쿠도커뮤니케이션", 
    "City": "서울특별시" 
  } 
}