March 2024 Summaries

PPE analytics has established itself as a pivotal player in the Personal Protective Equipment (PPE) sector by developing a comprehensive database and Product Information Management (PIM) tool that compiles data on over 55,000 PPE products, facilitating decision-making for manufacturers, distributors, and customers. The company adopted a Design-First approach for its API, emphasizing detailed documentation before coding to improve user experience and data structuring, using OpenAPI and leveraging Bump.sh for smooth integration and real-time updates. This strategy not only enhances their professional credibility but also positions them as a key data provider in a complex market, with clients such as Enedis, and ambitions to expand their influence across Europe.

The Train Travel API is an updated sample OpenAPI description for an imaginary train travel service, replacing the outdated PetStore example. It includes various open data sources and public APIs that demonstrate concepts and patterns used in designing this API. The schema components cover Stations, Trips, Bookings, and Booking Payments, with appropriate web standards usage and adherence to OpenAPI v3.1 conventions. The API design is built for modern JSON Schema and includes examples of polymorphism and variable payloads. Currently, there is no API implementation, but the project encourages feedback and collaboration in evolving and improving the OpenAPI description.

Bump.sh has decided to revamp its Help Center due to outdated information and the need for a more comprehensive resource covering their entire product and related topics such as API documentation. The process involved taking inventory of all features, creating an outline for the new Help Center structure, conducting regular synchronous review calls, choosing the right tool (Bridgetown), dividing work by section and page, and adjusting tone to cater to users with varying expertise levels. The team emphasized the importance of a living Help Center that evolves alongside their product.