apidays Australia 2022 - Accelerating API Engineering, Jason D'Souza & Andrew Saunders, NAB

apidays Australia 2022 - Enabling Business Networks
September 14 & 15, 2022

Accelerating API Engineering - Libraries, Templates and Governance?
Jason D'Souza, Enterprise Architect - Emerging Technology at NAB
Andrew Saunders, Architect - API Governance & Platforms at NAB
------------

Check out our conferences at https://www.apidays.global/

Do you want to sponsor or talk at one of our conferences?
https://apidays.typeform.com/to/ILJeAaV8

Learn more on APIscene, the global media made by the community for the community:
https://www.apiscene.io

Explore the API ecosystem with the API Landscape:
https://apilandscape.apiscene.io/

Deep dive into the API industry with our reports:
https://www.apidays.global/industry-reports/

Subscribe to our global newsletter:
https://apidays.typeform.com/to/i1MPEW

Transcript

1. Accelerating API Engineering Libraries, Templates & Governance? Jason D’Souza & Andrew Saunders, National Australia Bank September 2022
2. 2022 SERIES OF EVENTS New York JULY (HYBRID) Australia SEPTEMBER (HYBRID) Singapore APRIL (VIRTUAL) Helsinki & North MARCH (VIRTUAL) Paris DECEMBER (HYBRID) London OCTOBER (HYBRID) Hong Kong AUGUST (VIRTUAL) JUNE (VIRTUAL) India MAY (VIRTUAL) APRIL (VIRTUAL) Dubai & Middle East JUNE (VIRTUAL) Check out our API Conferences www.a pida ys .globa l Want to talk at one of our conferences? apidays.typeform.com/to/ILJeAaV8
3. About Us Jason D’Souza – Enterprise Architect • 15 years @ NAB • Vertical Potato Tower Farmer • Owner of NABs Emerging Engineering Acceleration Technologies Andrew Saunders – API Architect • 5 years @ NAB • Lover of Golden Retrievers • Owner of API Standards and Design Governance • Architect for NAB’s API Platforms Accelerating API Engineering linkedin.com/in/jasonmdsouza/ linkedin.com/in/andrewsaunders/
4. Building good APIs fast at scale is hard...
5. 6 tips to accelerate your API engineering 01 Innersource your codebases Crowdsource common problems together 04 Shift API Design Governance Left Sometimes it’s ok to say no... But do it early 02 Quickstart your developers Use templates and boilerplate code to get you there faster 05 Have API Standards, Enforce Them Make it harder to do the wrong thing. 03 Ensure accelerators are well known Help your engineers know what’s available 06 Educate on “What Good Looks Like” And so create a path of least resistance. Accelerating API Engineering
6. 1. Inner Source Proprietary software to open up the work internally • High quality software • Efficient development processes • Collaboration on code • Reuse of our codebase • Cross skilling engineers Accelerating API Engineering CONSUME Use, fork, follow, favourite CONTRIBUTE TIME Log bugs, add documentation CONTRIBUTE CODE Bug fixes, tests, new features OWN Influence Project Direction Review Code Welcome new contributions
7. API Testing Framework Created through innersourced collaboration Automated API Testing Framework Enables teams to easily create and maintain API integration tests at the same time getting a rich set of assertion and validation features • Single script can hit any API ENDPOINT and METHOD. • Data Driven framework using JSON. • Can run locally via Postman GUI/CLI or in a pipeline via CLI • Useful for various types of API Integration Tests such as Contract Testing, Functional Validation and Workflow Testing Working together on common tools
8. Recommended Git Repo Setup Standardised Metadata files to help make your innersourcing smooth File Purpose CODEOWNERS.md Engineers know who will approve their pull requests CONTRIBUTING.md How to make a change and what is expected of contributors CODE_OF_CONDUCT.md Acceptable behaviour for the project README.md Introduction to what the project is and what problem it solves ISSUE_TEMPLATE.md Enables issues to be raised consistently PULL_REQUEST_TEMPLATE.md Ensure that contributors understand minimum requirements LICENCE.md Appropriate licence for your organisation CHANGELOG.md Concise log of changes and releases Accelerating API Engineering See resources.github.com/innersource/fundamentals for more information
9. 2. Quickstarts & Accelerators Libraries Importable libraries ready for production Templates Production ready code in 1 click Tutorials User friendly tutorials References Snippets and reference implementations Engineering Driven Design Accelerating API Engineering
10. 3. Quickstart Discovery A focus on self service and high awareness Search, Browse and Find • Pulls and indexes directly from source repositories • Curated and sorted into engineering friendly categories • Helpful content on what to do next Market, Advertise and Celebrate • Community of Practices • Hackathons • Knowledge sharing Accelerating API Engineering
11. 4. Shift API Design Governance Left Be clear on why you are governing and against what Be Lean
12. Accelerating API Engineering •Get a group of API thinkers and leaders in your organisation to take accountability for Governance. •Use a Lean Canvas to help initiatives with API thinking and planning. •Do it early, while there’s still time to steer. •Shape rather than block. NAB version modified from APIOps™ API Canvas (License CC-BY-SA 4.0) API Model Canvas Create the right medium to enable a conversation.
13. 5. Have API Standards And Enforce Them Standards are useless unless you can be sure they’re being followed. •Set (or get) some API standards. •Build adherence to these standards into your API authoring and your delivery tooling. E.g. – Security – Conventions – Features – Design Approval •Have an owner and evolve your API Standards as necessary, updating and expanding the tooling. Accelerating API Engineering
14. 6. Educate On What Good Looks Like Govern less by creating the path of least resistance • Run regular API design bootcamps • Have API experts work directly with teams • Do API spec design reviews • Run a community of practice around APIs • Share updates on organisational social media
15. Putting it all together A production line for creating great APIs Accelerating API Engineering
16. Questions?
17. Thank you