Discover millions of ebooks, audiobooks, and so much more with a free trial

Only $11.99/month after trial. Cancel anytime.

REST API Design Control and Management
REST API Design Control and Management
REST API Design Control and Management
Ebook102 pages1 hour

REST API Design Control and Management

Rating: 4 out of 5 stars

4/5

()

Read preview

About this ebook

This book is designed to help those in a DevOp environment that are new to API, visualization of networking, storage and the control and management of such interfaces. After all technology has changed in so  much and in such a short time  it is no longer possible to write quick and easy scripts using username and password as authentication. Furthermore we can no longer  post the API up for the public without security, authentication and authorization.
 Similarly Operations only a few years ago had to managed and control network management systems without any programming knowledge, whereas developers knew nothing of networks – each to their own. However SDN and cloud development has changed everything. Now as DevOps we must understand how the environment we have inherited can co-exist and how we can manage it large scale and once more make it our own to manage and control 

LanguageEnglish
Release dateSep 19, 2015
ISBN9781516372799
REST API Design Control and Management

Read more from Alasdair Gilchrist

Related to REST API Design Control and Management

Related ebooks

Internet & Web For You

View More

Related articles

Reviews for REST API Design Control and Management

Rating: 4 out of 5 stars
4/5

4 ratings0 reviews

What did you think?

Tap to rate

Review must be at least 10 words

    Book preview

    REST API Design Control and Management - alasdair gilchrist

    API Design and Control for DevOps

    Copyright © 2015 Alasdair Gilchrist

    Description

    This book is designed to help those in a DevOps environment that are new to API, Microsevices, visualization of networking, storage and the control and management of such interfaces. After all technology has changed in so much and in such a short time it is no longer possible to write quick and easy scripts for APIs using basic authentication such as the username and password even with TLS. Furthermore we can no longer post the API up for the public without security, authentication and authorization.

    Table of Contents

    API Design and Control for DevOps

    Chapter 1 – An introduction to API

    What is an API?

    Application

    Interface

    API: A Technical Perspective

    API Analogy

    Example of an API

    What Is an API Call?

    Why Are APIs Important for Business?

    Common Concerns with open APIs

    Chapter 2 – SOAP Vs REST

    A Quick Overview of SOAP

    A Quick Overview of REST

    Deciding Between using SOAP or REST

    Soap Vs Rest

    Caching

    Security

    The Bottom Line: When to use SOAP or REST

    Chapter 3 - Restful API

    What is REST?

    HTTP methods

    Examples of REST

    Anatomy of a REST URL

    HTTP Status Codes

    Success codes:

    User error codes:

    API response formats

    Building a REST API

    Create a simple REST web service with Ruby

    Create a simple REST web service with Python

    Chapter 4 – Rest API Design Guidelines

    API affordance

    Names or Verbs

    Plural or Singular

    Case consistency

    URI case

    Body case

    Versioning

    CRUD

    Partial answers

    Errors

    Error Structure

    Status Codes

    SUCCESS

    Client Errors

    Server Error

    Chapter 5 – API Security & Authentication

    API authentication

    Basic Authentication w/ TLS

    OAuth v1.0a

    OAuth v2

    Chapter 6 – OAuth Access Control and Management

    Performance & Scaling

    Tailor the security to your needs

    Integrate with existing Identity & Access Management

    Design Token Policy

    Use the appropriate Grant Type

    Chapter 7 – API Management Best Practice

    5 Principles of API Management

    Expose Enterprise Data & Functions in API-friendly formats

    Protect information assets exposed by API

    Authorize secure, seamless access for valid identities

    Optimize system performance & manage the API lifecycle

    Engage, onboard, educate & manage developers

    Chapter 1 – An introduction to API

    Across industry sectors the boundaries of the data center and the company network are no longer fortified perimeters that once existed. Today, enterprises are opening up their data and applications to partners and third parties, through the Web, mobile apps, smart devices and the cloud. IT initiatives such as BYOD (Bring Your Own Device) have revolutionized and consumerized how IT organizations work with mobility and anywhere, anytime access to data and applications. Furthermore the advent of Cloud Computing and the proliferation of cloud service providers offering storage, compute and network services have enabled IT to shift their operations from the traditional data center to the cloud. API’s (Application Programming Interfaces) are the foundation of this new cloud open environment, which allows enterprises to move their data and applications across the traditional network boundaries.

    API’s enable businesses too quickly and efficiently repurpose IT systems, add value to existing applications and services and to open up new revenue streams. For developers and entrepreneurs APIs also open up a whole new world of possibilities by providing the means to integrate and reuse existing services offered by the web-scale giants such as Google, Yahoo, Facebook, etc. Developers can create their own applications using exposed web service APIs from these web giants to construct and develop their own applications. These web ‘mash ups’ might only consist of several web services linked together with some glue code but it is this type of reuse of available services that has created the boom in mobile and web applications over the last few years, which was only possible through the use of APIs.

    What is an API?

    Well let’s start with a basic deconstruct, a simple description, an API is an acronym for Application Programming Interface – and as such it comprises of a programmable interface to an application – it

    Enjoying the preview?
    Page 1 of 1