3.5.1.Requirements Analysis Process & Intro to REST Specifications

• API: Application Programming Interface

  • A user interface to data and systems that is consumed by applications rather than humans

  • A well defined contract between API provider and consumer

• Contract creation approach

  • contract last

    • API developer -> Code -> SPEC

    • Tough to keep the code and SPEC sync

  • contract first

    • API developer -> SPEC -> Code

    • Recommanded

• Specification

  • Collaboration between the App developer and API developer, together to carry out the requirement gathering analysis, then create the first version of the specification, mock is created from specification

    

• REST API Specification

  • apiblueprint

  • apiary

  • RAML

  • Swagger

    • De-facto standard supported by multiple vendors

      • apigee

      • ibm api management

      • mashery

      • layer 7 technologies

    • Vibrant community

• Benefits

  • What Swagger can do?

    • Developer documentation

    • Automated Proxy creation server code generation

    • Client code generation

    • Server virthualization