May 2023 Summaries

OpenAPI and AsyncAPI Tags are useful tools for organizing API endpoints in an API contract. They help categorize the contract by business function or logical objects, making it more readable and easier to understand. By defining tags at the root of the document and using them to group related endpoints, developers can improve the usability of their API contracts. Tags can also describe endpoint groups, link to additional documentation, and order endpoint groups in documentation. Some best practices for using OpenAPI and AsyncAPI tags include tagging all endpoints, making every tag unique, defining all tags in the root Tag Object, and ensuring that tags are meaningful and descriptive.

Mano Swerts, the Chief Technology Officer of AvioBook, has played a crucial role in reshaping the company's API strategy, focusing on bringing the power of AvioBook's APIs to customers. AvioBook, a Thales Group company, offers a comprehensive suite of solutions for airlines, which began with an Electronic Flight Bag (EFB) for pilots and has expanded to support various flight operations stakeholders. Swerts' leadership has been instrumental in addressing the challenges of API design and implementation by adopting OpenAPI and AsyncAPI specifications. This shift allowed for better documentation and accessibility of APIs using Bump.sh, which enhances visualization and version management compared to the previous Swagger UI. This development not only strengthens AvioBook's position as a leading platform in the airline industry but also facilitates more efficient collaboration within its teams and offers customers the ability to integrate seamlessly with their existing IT systems, contributing to safer and more efficient flight operations.

API-first design is a software development approach that emphasizes the creation of application programming interfaces (APIs) as the primary focus before developing other system components such as user interface (UI). This methodology is becoming increasingly important due to its ability to improve scalability, innovation, and adaptability in organizations. By prioritizing APIs, developers can create flexible and modular systems that are easily integrated with diverse systems and services. API-first design offers benefits like faster development times, improved developer experience, and better collaboration and communication among teams. However, it may not be suitable for all projects, particularly those without plans to offer an API or in nascent stages of development. The API-first design process involves several stages such as define, design, develop and document, test, secure, deploy, observe, and evolve. Various tools are available to aid developers in creating effective APIs, including documentation, mocking, testing, and API browsing tools.