1 / 9

API Coding & Design Standards for a Fundamental Model

This article explores the importance of following coding and design standards when building an API model. It discusses the interface correctness and sufficiency, testing, performance, stability, and evolution of the framework, as well as the unknowns and lessons learned during its development. It also examines the common components and their integration with the framework, addressing coding standards, testing, performance, stability, changes, and lessons learned. Additionally, it touches upon the underlying operating system and hardware, as well as the plan for the evolution of common components.

debbyr
Download Presentation

API Coding & Design Standards for a Fundamental Model

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Fundamental Model - Calling Thru an API Coding & design standards Interface correctness & sufficiency API Caller Test API Performance API Provider Change control / stability Lessons / Evolution

  2. Were coding standards followed? Framework unknowns Are there services that the Framework does not supply that applications will need? How to test the framework itself? Will there be performance issues for apps? xxxx framework (basic svcs) How stable is the framework? Will it change? Who is in charge of these changes? Underlying OS and HW What lessons from designing the Framework API will apply to designing component APIs? JMPS -- Building on Unknowns

  3. Common components unknowns Were coding standards followed? Who/what defines/enforces coding and development styles?? Will common component(s) need to go around the framework? For what reasons? What interfaces are exposed in the Common component(s) for the ABCs? Are there services that the Framework does not supply that applications will need? Common component - ZZZZ Common component – WWWW, etc How to test the framework itself? How do we test common component(s)? Will there be performance issues for apps? Will components raise performance issues? xxxx framework (basic svcs) How stable is the framework? Will it change? Who is in charge of these changes? Who controls changes to components? How are they decided upon? What are Lessons learned from the 1st common component? How to leverage these? What is the plan for evolution of common components? Underlying OS and HW What lessons from designing the Framework API will apply to designing component APIs? Instability at Lower Levels Can Lead to System Wide Chaos Note: Generic ABC is not totally representative of a “real” ABC or common component xxx -- Building on Unknowns

  4. Provides some validation of coding and development styles tt ABC tu ABC Provides some degree of interface validation Common component - ZZZZ Common component – WWWW, etc Provides testable, integrated thread throughout the system Enables system throughput analysis xxxx framework (basic svcs) Enables identification and handling of CM, version control and other stability issues Underlying OS and HW Enables initial validation of “system manager” roles xxxx – Full Architecture A complete pilot requires all layers. Will it all come together?

  5. UPC Development(s) document debug repair enhance test 1. Other Integration Efforts Integration 2. Integration Interface Artifacts 3. Integration Tasks

  6. UPC Development(s) Framework Common Components document debug repair enhance test Revision design dialogs Integration 2. Integration Interface Artifacts 3. Integration Tasks

  7. UPC Development(s) Framework Common Components document debug repair enhance test Revision design dialogs Source Repository(s) UPC Problem Reports Integration 3. Integration Tasks

  8. UPC Development(s) Framework Common Components document debug repair enhance test Revision design dialogs Source Repository(s) UPC Problem Reports Rebuild & test Help desk Evaluator / trainer Distribute planner Integration 2. Integration Interface Artifacts 4. Test Facility

  9. UPC Development(s) Framework Common Components document debug repair enhance test Revision design dialogs Source Repository(s) UPC Problem Reports test facility(s) Rebuild & test Help desk Evaluator / trainer Distribute planner 1. Other Integration Efforts Integration

More Related