To become useful, the API architecture needs to be put into practice. This is why this book covers an API methodology for design and development. An API methodology provides practical guidelines and explains how to develop an API architecture into an API that consumers love.

The methodology we propose is an outside-in approach, which also incorporates ideas of contract first design and simulation. In this methodology, the contract is expressed in the form of an API description. In each step of the methodology, an API description is either created, refined or used — the API description is the red thread connecting all the steps of the methodology.

Let’sĀ startĀ withĀ anĀ overviewĀ ofĀ theĀ phasesĀ inĀ thisĀ APIĀ methodology.Ā EachĀ phaseĀ ofĀ thisĀ methodologyĀ consistsĀ ofĀ aĀ creativeĀ partĀ andĀ aĀ verificationĀ part.Ā DuringĀ theĀ creativeĀ partĀ anĀ artifactĀ isĀ crafted,Ā duringĀ theĀ verificationĀ partĀ earlyĀ feedbackĀ onĀ theĀ artifactĀ isĀ collected.Ā InĀ eachĀ phaseĀ alongĀ theĀ designĀ andĀ developmentĀ journey,Ā weĀ elicitĀ feedbackĀ fromĀ theĀ consumers.Ā ThisĀ isĀ howĀ feedbackĀ canĀ beĀ collectedĀ asĀ earlyĀ asĀ possible,Ā whenĀ changesĀ toĀ theĀ APIĀ areĀ stillĀ possible,Ā relativelyĀ simpleĀ andĀ canĀ beĀ implementedĀ atĀ lowĀ cost.

ThisĀ methodologyĀ isĀ meantĀ toĀ beĀ usedĀ iteratively.Ā ThereĀ areĀ smallĀ iterations,Ā whichĀ areĀ triggeredĀ byĀ theĀ verificationĀ partĀ ofĀ theĀ sameĀ phase.Ā ThereĀ areĀ alsoĀ bigĀ iterations,Ā whichĀ areĀ triggeredĀ byĀ oneĀ ofĀ theĀ laterĀ verificationĀ phasesĀ andĀ requireĀ goingĀ backĀ toĀ theĀ creativeĀ partĀ ofĀ anĀ earlierĀ phase.Ā KeepĀ inĀ mind,Ā thatĀ inĀ anĀ iterativeĀ andĀ agileĀ approach,Ā notĀ allĀ informationĀ andĀ requirementsĀ aboutĀ theĀ constructedĀ artifactĀ areĀ presentĀ inĀ theĀ beginning,Ā butĀ newĀ andĀ moreĀ detailedĀ informationĀ isĀ gatheredĀ inĀ eachĀ iteration.

TheĀ APIĀ methodologyĀ consistsĀ ofĀ theĀ followingĀ phases:

  • DomainĀ analysis
  • ArchitecturalĀ design
  • Prototyping
  • BuildingĀ APIĀ softwareĀ forĀ production
  • PublishingĀ theĀ API

To learn more about puttingĀ APIs into practice, check outĀ my new book on API architecture and API methodology.

How to put API Architecture into Practice?

One thought on “How to put API Architecture into Practice?

Comments are closed.