Removing 4 obstacles that can slow down your API development workflow.
Tag: API Design
API Modelling: What is a Business Capability?
In the API design process, it is useful to first identify the business capabilities and the abstract resource model that support the design. This is because an API product specifies what business capabilities it provides. But what exactly is a business capability? According to Vernon [1] , a business capability is "a function of the … Continue reading API Modelling: What is a Business Capability?
RFC 7807 – Problem Details – Error Response
RFC 7807 provides a standard error message for web apis. It provides not just the high level status code but also finer grained details of the error.
Working on your organisations API design guidelines ? Here is a reference.
The API Stylebook http://apistylebook.com provides API designers with a curated list of publicly available API design guidelines (style guides). The guidelines are categorised by design topics making it easy to see what the approach taking by different API design guidelines on a specific topic. For example, Naming. Any working on API design guidelines and governance … Continue reading Working on your organisations API design guidelines ? Here is a reference.
API Breaking Change Policy – Examples
Here are a few examples of API breaking change policies. 1. LinkedIn API Breaking Change Policy 2. Microsoft Graph API Breaking Change Policy 3. HubSpot API Breaking Changes 4. Stripe API Upgrades 5. Twitter Versioning
Google API Improvement Proposal (AIP)
The Google API Improvement Proposal provides documentation on API Design guidance. The AIPs are are supervised by the API Governance team, and provide guidance to API producers and reviewers on topics like process, resource design, operations, fields, design patterns and compatibility. The AIPs are high-level design documents that help Google teams discuss and come to … Continue reading Google API Improvement Proposal (AIP)
API Guidelines
Erike Wilde maintains a collection of API guidelines here.
GDS API Design Guidance
The UK Government Digital Service publish their API design guide here.
API Design and Testing Tools
PostmanMocklabHoppscoth. [Github project. Web playground ].KarateInsomniaStoplight
Interesting Banking APIs
Here I keep a collection of core-banking related APIs I find interesting. Synapse https://docs.synapsefi.com/docs Moov https://api.moov.io/v1/ | https://github.com/moov-io/api | https://moov-io.github.io/accounts/api/#overview Mambu https://api.mambu.com/ Galileo https://docs.galileo-ft.com/ Solaris Bank https://docs.solarisbank.com/ Rails Bank https://docs.railsbank.com/ Griffin https://docs.griffin.sh/ . I like the Griffin API design https://docs.griffin.sh/reference#api-reference Wealth Kernel https://docs.wealthkernel.com/#introduction Clear Bank Developer Portal https://clearbank.github.io/docs/introduction/#overview Temenos API Catalogue: https://apidocs.temenos.com/api-catalog