OData Tool - Model First

Rongfang Wang

Software Engineer

Agenda

• Why develop Model First?

• What is Model First?

• How to use Model First?

• Where is Model First?

Why develop Model First?

Background

• Nowadays companies which produce internet applications (web/mobile) depend on RESTful APIs to fulfill different business needs.

• Exposing public RESTful APIs requires more work than just building the API.

1) API document: (available resources, the schema, sample requests/responses, behaviors, and etc.)

2) SDK

3) API validation tool

Traditional RESTful API development lifestyle

Des

ign

Imp

lem

en

tV

alid

ate

Do

cum

en

t

Requirement API Spec

API Doc

Service Validation Code

Finished Code

Manual writing

Manual coding Man

ual co

din

g

Man

ual w

riting

What is Model First?

Model First Capabilities

OData specific capability Generic capabilities

• Swagger is a popular framework for RESTful APIs.

• Swagger Specification has been donated to the Open API Initiative (OAI) and is the foundation of the OpenAPI Specification.

Swagger framework can provide the 3 generic capabilities mentioned previously

• Swagger document

• Swagger Editor

• Swagger provides a rich set of tools (i.e. Swagger Code Generator)

Proposed RESTful API development lifestyle D

esig

nIm

ple

me

nt

Val

idat

eD

ocu

me

nt

RequirementMachine-readable API representation

API Doc

Service Validation Code

Scaffold code Finished code

API Spec

Auto-Gen

Reduced manual coding

Auto-Gen

Au

to-G

en

Au

to-G

en

Interactive writing

Model First Design

OData conventions

RoutingKey…

JSON Model

YAML

EDM/CSDL

Scaffold code

Swagger Spec

Swagger Spec

EDM/CSDL

YAML

Input

Core Module

Output

How to use Model First?

New Guide Demo

Sample Demo

Generate Service Code Demo

Generate Client Code Demo

Where is Model First?

Resource

• Model First• Beta Hosted URL: http://apidocument.azurewebsites.net/

• Github：https://github.com/OData/model-first/

• Swagger Editor• Home: http://editor.swagger.io/#/

• OData team• Conventions: http://odata.org

• Mail to: odatafeedback@microsoft.com

Thank You!

Questions?

© Microsoft Corporation. All rights reserved.