Scribd
Upload
135 views20 pages

Api Design Practice

Api design best practices

Uploaded by

hvalola
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF or read online on Scribd
135 views20 pages

Api Design Practice

Api design best practices

Uploaded by

hvalola
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF or read online on Scribd
You are on page 1/ 20
5115125, 540 AM ‘API Design Practice. A practical guide to API QA and the... [by TRGoodwil| API Cenital | May, 2023 | Meum API Design Practice Apractical guide to API QA and the design of stable, coherent and composable business resource APIs TRGoodwill » Follow (QB uplishedin Pl Central 10 mintead - 5 days ago © Listen (Share Introduction An API specification document is a technical artifact, offering little opportunity for meaningful and timely input from business and enterprise stakeholders. It is absolutely the wrong place to begin designing an API. When building an enterprise API catalog of reusable, stable, coherent and composable APIs, an enterprise-guided, domain-oriented API Design Practice is essential. API Design Goals The API Design Phase is centered around the capture and validation of the domain data model and the state-lifecycle of business resources. The quality of the data / REST model has significant impact on the usability, evolvabilty and security of an API. Collaborative design workshops and modeling tools will allow a diverse group of stakeholders, from business owners, enterprise and domain architects, data modelers, security architects, REST and EDA SMEs, tech leads and developers, to interact with (and contribute to) the same domain data model, and be notified of changes that interest them. In this way, the domain model “acts as a Ubiquitous Language to help communication between software developers and domain experts” (Fowler, M 2014, BoundedContext), tps simedium.comlap-conterfan/-design-pracice- 76908336 4120 5115125, 540 AM ‘API Design Practice. A practical guide to API QA and the... [by TRGoodwil| API Cenital | May, 2023 | Meum maximizing collahoration nrawidine the tichtest nassihle feedhack Inon. and ensuring that the don Align Resour From the business intormation, events and processes managed by a System-of-Record business service, are abstracted one or more canonical business resource APIs. Business resources represent the nouns of a system, such as ‘applications’ and ‘applicants’. They provide a context for interaction with a business capability, represent the business facts about a business domain, and when consistently modeled, discoverable and subscribable, they become the backbone of a federated data platform. Design for Composability Microservices architectures and the REST architectural style enable decoupling, self- service and re-use by moving the responsibility for choreography from the resource server to the client. This shift in responsibility allows business systems to build stable, genericised interfaces to their business resources and capabilities, without tight coupling to client systems, which in turn allows client systems to compose data via self-service integration without a blocking dependency on external teams. Bh overs { 6H Product (D invoices c=) = F reymenis API clients will typically want access to core information about a specific business object, not complex data structures, and they want it FAST. A good REST model is concerned with finding a balance between granularity and cohesive units of business tps simedium.comlap-conteran/-design-pracice-7o608336e 2120 5115125, 540 AM ‘API Design Practice. A practical guide to API QA and the... [by TRGoodwil| API Cenital | May, 2023 | Meum data likely to he of interest ta client evstems (thoneh not snnerfinons to their needs). In short, balan, aodeled as sub-resoure Early and Continuous Stakeholder Engagement Business domain expertise and enterprise API Design Standards inform The API Design Phase. A REST model provides the means for external systems to securely interact with business objects, data and processes via standard, generic RESTful operations. The quality of the model has significant impact on the usability, evolvabilty and security of an API. There are many stakeholders invested in shaping and validating the model, stakeholders may include: * Business owner (domain expert), Domain architect, Enterprise architects (Enterprise, Security, Data) API Platform REST SME, Tech lead / API Developers Closely aligned client application teams. tps simedium.comlap-conteran/-design-pracice-7o608336e 5115125, 540 AM {API Design Practice. practical guide to API QA and the... [by TRGoodwil| AP! Cenital | May, 2023 | Meum unt You ar I (pu__@g__.com) to view Aggregate (Qe) | () State-lifecycles roots & boundaries \ Lf & Business Events Security Architecture 7 : — —_— Data Commands classification & assertions & security controls / ‘oO Entities & Industry 69 9)

You might also like