data_object
Doing the API work
Design API interactions based on identified requirements for API products. Document for API contract design and software delivery.
api
API Design
login
Entry criteria
- The API uses architecture patterns promoting reusability for multiple API-consumers.
- The architecture ensures the APIs will integrate seamlessly with the infrastructure and platforms.
- Architecture requirements and decisions have been documented and validated with stakeholders.
- API is designed to meet API consumer needs hiding backend data models and discrepancies.
- The API and its endpoints have a description that explains its business value and features.
- API has a consistent design with our other API products.
logout
Exit criteria
- The API uses architecture patterns promoting reusability for multiple API-consumers.
- Architecture requirements and decisions have been documented and validated with stakeholders.
- API is designed to meet API consumer needs hiding backend data models and discrepancies.
- API interactions and data models have a consistent design with our other API products and design guidelines.
settings
Enabling the API work
- Provide reusable templates, standards, and validation tools for API specifications
What type of API are you building?
API Cheat sheet helps you to understand the basic differences when building Private, Partner or Public APIs
Prototype
- No coding required.
- OpenAPI with examples
- Mock and test agains the prototype
- Give prototype out for comments and building for API consumers
What type of API are you building?
API Cheat sheet helps you to understand the basic differences when building Private, Partner or Public APIs
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
