Build APIs
Build APIs: Prototype, build or scale depending on what architecture phase you are on.
Prototype
- No coding required.
- OpenAPI with examples
- Mock and test agains the prototype
- Give prototype out for comments and building for API consumers
Build Just Enough
- Build so the interface works, it doesn't need to be super pretty, yet
- Protect with API management
- Set up CI/CD pipelines
- Do load testing, don't build for “theoretical future load”.
Scale
- Test coverage up, before optimizing
- Build for change
- Scale the API management
- Automate load testing.
- Check auto-scaling possibilities for all components but check also costs
What type of API are you building?
API Cheat sheet helps you to understand the basic differences when building Private, Partner or Public APIs
Private APIs are allowed to be used only by own applications. They contain attributes and data that is business critical and confidential
Partner APIs are available for third-party organizations upon approval of partnership terms and conditions. Partner APIs may contain partner specific or customer data which is not available for general public. Partner is liable for the use of the data according to terms and conditions. The partner may be required to restrict the access of their end-users to the data. For example, a partner may access detailed price and purchase data of all stores but each retailer using partner’s application is only able to access data of their own store.
Public APIs can be used by anyone without specific approval. APIs can still be authenticated with client id and secret to enforce rate limits and some general terms of use may apply.
