Upload File

choose json for building apis

2
SearchSOA.com Choose JSON for building APIs By null More and more, developers who are used to working in the Web and mobile worlds naturally turn to APIs as the most effective way to connect clients and servers, according to Greg Brail. As these developers encounter applicationtoapplication problems like businesstobusiness connections between enterprises, their first reaction is, "Why can't we just use an API here?" Brail answers that APIversusmiddleware question and compares APIbased integration to SOA and enterprise service busses (ESBs) approaches in this SearchSOA interview. He also offers advice on such API matters as change management, XML vs. JSON data formats and uses for hypermedia. Coauthor of the O'Reilly book, APIs: A Strategy Guide , Brail has a long history in middleware development. He built middleware libraries for Citibank and was principal architect for transact plus technical lead for BEA’s WebLogic JMS. At Apigee , an API and middleware backend as a service provider, he is the architecture lead for all products. When and why should APIs replace integration middleware? Greg Brail: Just as APIs are fast enough for the most demanding mobile applications, and secure enough for important consumerfocused use cases, there is no reason why they cannot be the default choice for integration tasks as well. There is very little reason to use a more traditional applicationtoapplication protocol or integration technology when an API can be used instead. Exceptions, I think, are fewer and farther between than people think. A good example would be applications like highfrequency financial trading, where the throughput and latency demands are so extreme that even TCP, let alone HTTP, is just too slow. Even where more typical enterprise technology like message queuing and publish/subscribe is used, in many cases, wrapping the messaging system with an API makes it easier to consume. How do APIs as an integration approach compare to SOA and ESBs? Brail: SOA is about connecting services within the enterprise to achieve reuse and save money. APIs build upon SOA by emphasizing developer usability and selfservice, and about creating new services that can be used both inside the enterprise as well as by customers, partners, and developers. SOA didn't do much to enable those kinds of use cases. ESBs solve part of the API integration and SOA problem, but APIs are a lot more. For instance, ESBs do nothing to make it easier for developers to consume APIs via selfservice, and they do nothing to make an existing system of record safe for mobile use on the Internet by managing hightraffic volumes and providing advanced security and threat detection. Our readers tell us that change management is a pain point in API management. What process and technical problems does it pose? Brail: An API is a contract between the API provider and the developer. Any contract has to clearly state what might change and how the developer will know about those changes. In the most common API style the URI and verbbased style that most developers understand it's generally understood that once a particular URI/verb combination is out there, it won't go away without a lot of notice, or change in an incompatible way. The key to making this contract work is good testing. Today we have tools like Swagger that let us formally specify the format of an API, and there are more and more tools appearing on the market that can use that data to test and verify an API. Without continuous testing of the API implementation, it's hard to guarantee that the contract remains valid. What are best practices, criteria and consequences of errors in choosing data formats (XML, JSON, etc.) when designing and building APIs ? Brail: Today, I think it's hard to go wrong with JSON. It's the easiest format to create and parse in nearly any language because it is so close to what most programming languages expect, parsing is reasonably fast, and it's readable enough. I think that 95% of APIs should just stick with JSON. The other 5%, in mind, breaks down into use cases where extreme performance is needed, and use cases where there are existing XML schemas that represent a lot of intellectual capital that you want to reuse. For extreme performance, see again highspeed trading. I'm talking about extreme performance, not a mere few thousand of tens of thousands of API calls per second. For existing XML schemas, see standards like FpML [Financial Products Markup Language] and the like where a lot of people spend a lot of time trying to create a common way to describe some very complex things in XML.

Upload: lalatendurath5716

Post on 07-Sep-2015

230 views

Category:

Documents


0 download

Report

DESCRIPTION

d

TRANSCRIPT

  • SearchSOA.com

    ChooseJSONforbuildingAPIs

    Bynull

    Moreandmore,developerswhoareusedtoworkingintheWebandmobileworldsnaturallyturntoAPIsasthemosteffectivewaytoconnectclientsandservers,accordingto

    GregBrail.Asthesedevelopersencounterapplicationtoapplicationproblemslikebusinesstobusinessconnectionsbetweenenterprises,theirfirstreactionis,"Whycan'twejustuseanAPIhere?"

    BrailanswersthatAPIversusmiddlewarequestionandcomparesAPIbasedintegrationtoSOAandenterpriseservicebusses(ESBs)approachesinthisSearchSOAinterview.HealsooffersadviceonsuchAPImattersaschangemanagement,XMLvs.JSONdataformatsandusesforhypermedia.

    CoauthoroftheO'Reillybook,APIs:AStrategyGuide,Brailhasalonghistoryinmiddlewaredevelopment.HebuiltmiddlewarelibrariesforCitibankandwasprincipalarchitectfortransactplustechnicalleadforBEAsWebLogicJMS.AtApigee,anAPIandmiddlewarebackendasaserviceprovider,heisthearchitectureleadforallproducts.

    WhenandwhyshouldAPIsreplaceintegrationmiddleware?

    GregBrail:JustasAPIsarefastenoughforthemostdemandingmobileapplications,andsecureenoughforimportantconsumerfocusedusecases,thereisnoreasonwhytheycannotbethedefaultchoiceforintegrationtasksaswell.ThereisverylittlereasontouseamoretraditionalapplicationtoapplicationprotocolorintegrationtechnologywhenanAPIcanbeusedinstead.

    Exceptions,Ithink,arefewerandfartherbetweenthanpeoplethink.Agoodexamplewouldbeapplicationslikehighfrequencyfinancialtrading,wherethethroughputandlatencydemandsaresoextremethatevenTCP,letaloneHTTP,isjusttooslow.

    Evenwheremoretypicalenterprisetechnologylikemessagequeuingandpublish/subscribeisused,inmanycases,wrappingthemessagingsystemwithanAPImakesiteasiertoconsume.

    HowdoAPIsasanintegrationapproachcomparetoSOAandESBs?Brail:SOAisaboutconnectingserviceswithintheenterprisetoachievereuseandsavemoney.APIsbuilduponSOAbyemphasizingdeveloperusabilityandselfservice,andaboutcreatingnewservicesthatcanbeusedbothinsidetheenterpriseaswellasbycustomers,partners,anddevelopers.SOAdidn'tdomuchtoenablethosekindsofusecases.

    ESBssolvepartoftheAPIintegrationandSOAproblem,butAPIsarealotmore.Forinstance,ESBsdonothingtomakeiteasierfordeveloperstoconsumeAPIsviaselfservice,andtheydonothingtomakeanexistingsystemofrecordsafeformobileuseontheInternetbymanaginghightrafficvolumesandprovidingadvancedsecurityandthreatdetection.

    OurreaderstellusthatchangemanagementisapainpointinAPImanagement.Whatprocessandtechnicalproblemsdoesitpose?

    Brail:AnAPIisacontractbetweentheAPIproviderandthedeveloper.Anycontracthastoclearlystatewhatmightchangeandhowthedeveloperwillknowaboutthosechanges.InthemostcommonAPIstyletheURIandverbbasedstylethatmostdevelopersunderstandit'sgenerallyunderstoodthatonceaparticularURI/verbcombinationisoutthere,itwon'tgoawaywithoutalotofnotice,orchangeinanincompatibleway.

    Thekeytomakingthiscontractworkisgoodtesting.TodaywehavetoolslikeSwaggerthatletusformallyspecifytheformatofanAPI,andtherearemoreandmoretoolsappearingonthemarketthatcanusethatdatatotestandverifyanAPI.WithoutcontinuoustestingoftheAPIimplementation,it'shardtoguaranteethatthecontractremainsvalid.

    Whatarebestpractices,criteriaandconsequencesoferrorsinchoosingdataformats(XML,JSON,etc.)whendesigningandbuildingAPIs?Brail:Today,Ithinkit'shardtogowrongwithJSON.It'stheeasiestformattocreateandparseinnearlyanylanguagebecauseitissoclosetowhatmostprogramminglanguagesexpect,parsingisreasonablyfast,andit'sreadableenough.Ithinkthat95%ofAPIsshouldjuststickwithJSON.

    Theother5%,inmind,breaksdownintousecaseswhereextremeperformanceisneeded,andusecaseswherethereareexistingXMLschemasthatrepresentalotofintellectualcapitalthatyouwanttoreuse.Forextremeperformance,seeagainhighspeedtrading.I'mtalkingaboutextremeperformance,notamerefewthousandoftensofthousandsofAPIcallspersecond.ForexistingXMLschemas,seestandardslikeFpML[FinancialProductsMarkupLanguage]andthelikewherealotofpeoplespendalotoftimetryingtocreateacommonwaytodescribesomeverycomplexthingsinXML.

    http://searchwindevelopment.techtarget.com/definition/JSON-Javascript-Object-Notationhttps://apigee.com/about/http://shop.oreilly.com/product/0636920021223.dohttp://searchexchange.techtarget.com/definition/application-program-interfacehttp://searchsoa.techtarget.com/definition/enterprise-service-bushttp://searchsoa.techtarget.com/definition/XMLhttp://searchcio.techtarget.com/definition/change-managementhttp://whatis.techtarget.com/definition/FpML-Financial-Products-Markup-Languagehttp://searchsoa.techtarget.com/definition/service-oriented-architecturehttp://searchsoa.techtarget.com/tip/API-design-How-to-properly-build-an-application-program-interface

  • WhatapproachesshoulddevelopersandarchitectstaketodesignAPIsthataremoreusabletodayandviableinthefuture?Brail:Therearesomeplaceswherehypermedia[whichextendshypertextlinkingtoincludelinksamonganysetofmultimediaobjects]isveryeffective.IftheAPIproviderandthedevelopersunderstandeachotherwell,andagreeonaconventionandcontract,thenahypermediadrivenAPIcanbethebasisforarobustandefficientuserexperienceonethatallowstheAPIprovidertoadjustontheflytochangingnetworkandmarketconditions,inthesamewaythatatraditionalWebappcanbechangedbasedonuseranalytics.Idon'tthinkwe'llseehypermediabasedAPIsreplacetheideaofaverywelldescribedURIpatternforeverythingintheworld,butittheybecomeaveryeffectivewaytowritemobileapps.

    Finally,IthinkthattheideaofmakingamoretraditionalAPI"navigable"byaddinghypermedialinksthatletaclientbrowsetheAPIjustasaWebuserbrowsesawebpage,issomethingthatalotmoreAPIsshouldbedoingtoday.

    30Jun2015

    AllRightsReserved,Copyright20012015,TechTarget|ReadourPrivacyStatement

    http://searchsoa.techtarget.com/about/copyrighthttp://www.techtarget.com/html/privacy_policy.htmlhttp://searchsoa.techtarget.com/definition/hypermedia

Data APIs and working with JSON Data Visualization Outline · Data APIs and working with JSON Data Cleaning with Open Refine Data Visualization. API Challenges Application Programming

SOAP, REST and GraphQL · RESTful APIs != HTTP APIs • HTTP is a transport protocol! • You do SOAP over HTTP, you do REST over HTTP, you can use JSON with SOAP and XML with REST

Open Retailing Design Rules for JSON - Conexxus...This document describes the Open Retailing (fuel retailing and convenience store) style guidelines for the use of JSON based APIs,

Rich Applications - CORE · RDF ! JSON ! jquery ! HTML5 ! JAVASCRIPT ! Objective C ! Java ! APIs … Not that easy! ... APIs Mash-ups HTML5 jQuery/Javascript (self taught) Business

JSON Schema: Valide e navegue entre suas APIS

[Short talk] o poder das APIs - rest, json e além

JSON オブジェクト - Cisco€¦ · •JSONの例：APIProvisionParams, 4ページ •JSONの例：APIServiceContainerTemplate,4ページ JSON オブジェクトパラメータタイプ

JSON - wcw.cs.ui.ac.id · JSON •JavaScript Object Notation ... •JavaScript is a superset of JSON. A JavaScript compiler is a JSON decoder

Week 4: python - Donutsdrgates.georgetown.domains/ANLY500/Week4.pdf · TOPICS: PYTHON 1) Web Scraping - HTML review - urllib - requests - beautifulsoup 2) Using APIs - JSON - GET/POST

CIS14: Baking Fine-Grained Authorization Into Your Apps and APIs using ALFA, REST, and JSON

Protocols & communication formats[XML/JSON] & APIs · delivering new functionality to the web community, e.g. Facebook Application platform API in object-oriented languages: usually

PhlyRestfully - ZF2 module for creating RESTful JSON APIsPhlyRestfully - ZF2 module for creating RESTful JSON APIs, Release 2.1.0dev •Make a request, using the Accept header with

Pro RESTful APIsenglishonlineclub.com/pdf/Pro RESTful APIs - Design... · 2019-09-21 · Pro RESTful APIs: Design, Build and Integrate with REST, JSON, XML and JAX-RS Sanjay Patni

Lecture 3: json, ajax, APIs IN5320 - Development in ...Allows transfer of data in formats such as XML, JSON or plain text. In essence, ajax allows you to: Read data from a web-server

Creating Web APIs with JSON-LD and RDF

Drive new business opportunities through naturally RESTful ... · Drive new business opportunities through naturally RESTful APIs and JSON ... document REST APIs: –API Blueprint

PhlyRestfully - ZF2 module for creating RESTful JSON APIs

APIS M / APIS 15 / APIS 13 / APIS WR / APIS E - skynet.beusers.skynet.be/am259776/APIS FOLDER.pdf · APIS M / APIS 15 / APIS 13 / APIS WR / APIS E APIS, CARAT, AM- 01, DG- 303 ELAN,

Global Markets Beyond Legislations - MarkLogic · XML or JSON), without modification (no filtering / transformation), and using . any technology (e.g. messages, files, ESB, APIs)

Protocols & communication formats[XML/JSON] & APIs

1 WebSocket & JSON Java APIs Hackday By Somay Nakhal @SomayNakhal David Illsley @davidillsley

Morgan Leonard - morglblog.files.wordpress.com · 08/02/2015  · jQuery Backbone Jasmine Webdriver IO AJAX JSON Express.js Node.js REST APIs VisualStudio Jade Agile Bootstrap Mocha/Chai

JSON-RPC JSON RPC

JSON Pointer and JSON Patch

Building effective Restful APIs with Oracle Rest …...Building effective Restful APIs with Oracle Rest Data Services 19 7 Oracle JSON collection-based schema-less access. Supports

PhlyRestfully - ZF2 module for creating RESTful JSON APIs - ZF2 module for creating RESTful JSON APIs, Release 2.1.0dev 2 CONTENTS. CHAPTER ONE HAL PRIMER HAL, short for “Hypermedia

Beautiful REST + JSON APIs · • APIs, REST & JSON • REST Fundamentals • Design Base URL Versioning Resource Format Return Values Content Negotiation References (Linking) Pagination

ITP 342 Mobile App Development - bcf.usc.edubcf.usc.edu/~trinagre/itp342-20153/lectures/ITP342_APIs.pdfas being RESTful • RESTful web service ... JSON, PHP) – Library-based APIs,

Web-APIs - elaspix.de · Web-APIs Examples ... Machine understandable due to semantic hierarchy. JSON

Preloading and DOM DOM Table Object and JSON …users.du.se/.../lectures/IA_12_internet-apps-html5-api2.pdfPreloading and DOM DOM Table Object and JSON File upload, HTML5 File APIs

Advanced API Security Healthcare Information Privacy ... › sgw › documents › 1451044 › ... · Securing APIs with OAuth, OpenID, and JSON Practical API Security is a complete

COMPASS-CP: An interoperable SMART on FHIR application · – Open architectures and APIs (REST, JSON LD) – Semantic Interoperability (ontologies, RDF representations) – Standards

Design Beautiful REST + JSON APIs

Beautiful REST+JSON APIs with Ion

Composing JSON-based Web APIs