Workshop & Webinar showcasing a collaborative API Delivery Scenario

A repo storing assets related to webinar demonstrating a collaborative API design and delivery journey using SwaggerHub, ReadyAPI, and PactFlow

Tooling integration - SmartBear API Platform

In this guide, you'll learn how to use the SmartBear API Platform, to add improve confidence and add visibility to your design first API development workflow.

• PactFlow
• SwaggerHub
• ReadyAPI
• SwaggerHub Explore

Benefits

SmartBear's API Platform tools can be combined to increase the quality of your design-first API development workflow, and help navigate the complexity of microservices rollout.

SwaggerHub is foundation of a repeatable process for API Development, providing a secure collaborative environment for your API design process:

1. It unifies teams around a single source of truth - the OAS - and enables standardisation across your services
2. Allows teams to work independently
3. Unlocks automation such as code-generation and mock services

PactFlow brings increased visibility into how consumers use your API, enabling:

1. API consumer and API producer development teams to work in independently and safely
2. Prevent breaking changes to your API and releasing an incompatible API consumer
3. A reduction in the need for API versioning, avoiding the need to create and maintain multiple versions of an API, and communicating the change to consumers.

Together, they allow faster feedback cycles from design through to development, test and release.

Pre-requisites:

To use this feature, you will need:

• A PactFlow account (create a free account).
• A SwaggerHub account (create a free account).
  • For the SwaggerHub/PactFlow integration, you will need a team /enterprise account, to create private API's, or you can use the integration for the first 14 day trial of enterprise.
• A ReadyAPI account (create a free 14 day trial account).

The FinTech Scenario

Our company SmartBearCoin is expanding to offer services across the wider European region and thus our Payments Domain (business capability) are extending our payment processing sub-capability to cater for cross border payments.

The Business Requirements

The Payments capability has requested the following from Customer Management capability:

The ability to be able to retrieve customer information to help them have up-to-date and accurate payee information at the point to issuing a cross border payment. It was also mentioned was the need to obtain payment transaction summary information for payees but the ask was not very clear 😕

Overview

• Establish the business requirements and set the scene ​
• Enforce API design standards to meet regulatory requirements ​
• Use SwaggerHub to unlock the advantages of the design-first approach for APIs​
• Use ReadyAPI for integrated API testing (functional/security/perf)​
• Use ReadyAPI setup rich API virtualization ​
• Use PactFlow Implement bi-directional API contract testing ​
• Leverage API definitions and artifacts for DevOps automation​
• Run through provider and client deployments with quality-gated CI/CD flows​
• Demonstrate how we can safely catch breaking changes​

Deliverables

• FrontEnd

  • Team: Financial Payments Team
  • Tech: React / TypeScript
  • Deployment: GitHub Actions / Netlify
  • Tools Used:
    • SwaggerHub
    • Pact
    • PactFlow

• BackEnd

  • Team: Customer Management Team
  • Tech: .NET Core 6 / Azure Functions
  • Deployment: GitHub Actions / Azure
  • Tools Used:
    • SwaggerHub
    • ReadyAPI
    • PactFlow

Integration Guide

Requirements & Design

1. Create your API definition in SwaggerHub
   1. https://support.smartbear.com/swaggerhub/docs/apis/creating-api.html
2. Enable AutoMocking to ensure you have a VirtServer available for users to explore, prior to development work beginning.
   1. https://support.smartbear.com/swaggerhub/docs/integrations/api-auto-mocking.html
3. Utilise Domains to utilise libraries of common components used across your business
   1. https://support.smartbear.com/swaggerhub/docs/domains/index.html
4. Invite your team members to collaborate on your API
   1. https://support.smartbear.com/swaggerhub/docs/organizations/working-with/add-delete-users.html#add
5. Collaborate via comments
   1. https://support.smartbear.com/swaggerhub/docs/collaboration/comments.html

Testing & Virtualisation - Provider

1. Import OpenAPI from SwaggerHub to ReadyAPI
   1. https://support.smartbear.com/readyapi/docs/integrations/swagger.html
2. Create ReadyAPI Functional Tests in the newly created Project
   1. https://support.smartbear.com/readyapi/docs/functional/creating.html#from-project
3. Test ReadyAPI tests against VirtServer locally in ReadyAPI
   1. https://support.smartbear.com/readyapi/docs/functional/running/case.html
4. Test ReadyAPI tests against VirtServer locally with test runner GUI
   1. https://support.smartbear.com/readyapi/docs/functional/running/automating/gui.html
5. Test ReadyAPI tests against VirtServer locally with test runner docker image
   1. https://support.smartbear.com/readyapi/docs/integrations/docker/soapui.html
6. Test ReadyAPI tests against VirtServer in CI

   1. webinar-collaborative-api-delivery-fintech/.github/workflows/ProviderCI.yml

      Lines 71 to 80 in aca0b64

      	- name: Test
      	run: chmod ugo+rwx ReadyAPI_Tests && ./startServerAndTest.sh
      	env:
      	PROJECT_FOLDER: ReadyAPI_Tests
      	PROJECT_FILE: 'SmartBearCoin-Payee-Provider-readyapi-project.xml'
      	SLM_API_KEY: ${{ secrets.SLM_API_KEY }}
      	SERVER_DIR: provider_azure_function
      	SERVER_COMMAND: 'func start --csharp'
      	WAIT_FOR: 'http://localhost:7071'
      	ENDPOINT: http://localhost:7071/api

7. Upload to Provider Contract to PactFlow
   1. https://docs.pactflow.io/docs/bi-directional-contract-testing/contracts/oas#publishing-the-provider-contract--results-to-pactflow

 Coding & Deployment - Provider

See provider_azure_function/README.md

 Coding & Deployment - Consumer

See smartbearcoin-payments-ui/README.md

 Exploration

You can utilise SwaggerHub Explore to see how an API behaves in the real world, whether the API is deployed to an environment, or running locally on your machine. It's free to sign in with your SwaggerHub account.

Explore a live API

1. Visit https://explore.swaggerhub.com/
2. Copy the following URL and paste it into the address bar
   1. https://sbdevrel-fua-smartbearcoin-prd1.azurewebsites.net/api/payees?country_of_registration=IE&jurisdiction_identifier=06488522&jurisdiction_identifier_type=chamber-of-commerce-number
3. Press Send
4. Congrats 🎉 you just send your first request in Explore.

Explore a local API

1. Visit https://explore.swaggerhub.com/
2. Click on the network connection icon
3. Select Local connection
4. Download the relevant explore local execution agent for your platform (Windows/Linux/MacOS)
5. Run the local execution agent
6. Run the provider code as described above in the Coding & Deployment - Provider so that your API is locally running
7. Use cURL and check you can call the API correctly
   1. curl http://localhost:7071/api/payees?country_of_registration=IE&jurisdiction_identifier=06488522&jurisdiction_identifier_type=chamber-of-commerce-number
8. Copy the following URL and paste it into the address bar
   1. http://localhost:7071/api/payees?country_of_registration=IE&jurisdiction_identifier=06488522&jurisdiction_identifier_type=chamber-of-commerce-number
9. Press Send
10. Congrats 🎉 you just send your first request to a locally running service with Explore.