oracle-apac-developers-meetup-2-building-api-with-apiary-slides

Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted
Building API with Apiary
Boopathy Balasubramanian
Oracle, Asia R&D Center
March 28, 2018
Oracle Developer Group Meetup #2

Copyright © 2017, Oracle and/or its affiliates. All rights reserved. |
Safe Harbor Statement
The following is intended to outline our general product direction. It is intended for
information purposes only, and may not be incorporated into any contract. It is not a
commitment to deliver any material, code, or functionality, and should not be relied upon
in making purchasing decisions. The development, release, and timing of any features or
functionality described for Oracle’s products remains at the sole discretion of Oracle.
Confidential – Oracle Internal/Restricted/Highly Restricted 2

Meetup Agenda
Introduction
Apiary Toolsets
Design your own API
Q & A
1
2
3
4

Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 4
What is API?

Importance of API & It’s Design
APIs make up the new
medium for businesses to
communicate with each
other.
Design is very important
when they come to
interacting with web APIs.
Good design allows huge
infrastructure and
implementations changes
without changing a line of
code and API clients.
A good web API design is,
• Decoupled from
implementation details.
• Able to evolve without breaking
existing clients.

As the importance of API’s increases, more
responsibility lies on those who build and
manage the APIs.
Apiary solves the fundamental task of
improving API development, by meeting all
the increasing expectations and also
streamlining the business process of how
work gets done.
: powerful API design stack

General API Life Cycle Flow
• This way a new API can be designed in
very limited time.
• Easily shared with other members for
their comments and can be mocked
without writing any code
Apiary API Life Cycle Flow

Connect and Collaborate
• Building great APIs is all about effective collaboration.
• App developers, testers, architects, product managers, clients, and partners
all bring unique perspectives to the design of your APIs.
• To be successful, your team needs to make sure every stakeholder has a
say.

Apiary Toolsets.

• Apiary Editor
• Interactive Documentation
• Mock Server
• Testing Debugger(API Inspector)
• GitHub Sync
• Automated Implementation Testing
: Core Toolset

Apiary Editor
The Apiary Editor is the foundation of your API
design. Apiary Editor supports API Blueprint and
Swagger API Description languages.
• API Blueprint
• Swagger

Apiary Editor

Interactive Documentation
Apiary interactive documentation is an interactive representation of your API Description for you to
not only read and write, but to be a place where you can interact with your API—even before
you’ve built it.

Interactive Documentation

Mock Server
Use Apiary Mock server to quickly preview your API and share it with others.
In the design phase of an API, it is helpful to experiment with how you feel your API should work
and iterate on this process quickly. In the past, this involved writing code as a prototype and setting
up a server to run it. This takes time and directly effects the creativity behind the design process.
The Mock Server allows you to try out your API as you design it, giving immediate feedback along
the way in how it may be used.

Mock Server

API Inspector
Each request and response from the Mock Server is logged in the API Inspector, which can be found
by clicking “Inspector” in the Apiary header. There you will see each request received, each
response given, and any validation errors that were found.

API Inspector

GitHub Sync
Keep your API Description in sync with your implementation and make it available to anyone with
access to the repository.
Automated Implementation Testing
An important part of the API life cycle is to make sure that what the contract says is what is actually
implemented, and that’s the place for Automated Testing. Testing works by taking your API
Description, creating expectations based on the requests and responses in the blueprint, making
requests to your API, and seeing if the responses match. The goal is to have the documentation and
implementation of the API in sync—no more outdated API documentation.

• GitHub Integration
• Apiary CLI
• Embed documentation
• API Style Guide
: Additional Toolsets

Time to design your own API
Hand-On.

Let’s walk out with
• How to access apiary and it’s toolsets.
• Able to design and test a simple API in less than an hour.
This should set enough foundation for you to carry on your discovery journey
if you find it interesting.

Pre-Requisites
• Environment
– Windows/Linux/Mac laptop
– Access to internet
• Please use clear-guest Wi-Fi access
point
Here‘s what we need to get started with the Hands-On
• Account
– An Apiary account
(https://apiary.io/) - Register for free.
• Alternate options for signup
– GitHub account.
– Twitter Account.
We’ve prepared a simple API blueprint, if you want you can get that do
modification to try it in apiary.

Q & A.

Recap
• Design and run a simple rest API and share it with anyone in less than an
hour.
• Test and monitor the rest API within single web UI.
• Easy way to maintain your rest API documentation.

oracle-apac-developers-meetup-2-building-api-with-apiary-slides

Recommended

Recommended

More Related Content

What's hot

What's hot (19)

Similar to oracle-apac-developers-meetup-2-building-api-with-apiary-slides

Similar to oracle-apac-developers-meetup-2-building-api-with-apiary-slides (20)

Recently uploaded

Recently uploaded (20)

oracle-apac-developers-meetup-2-building-api-with-apiary-slides