June 2025 Summaries

Partner APIs, though less publicly acknowledged than public APIs, hold significant potential for driving business growth and collaboration by enabling co-creation and opening new revenue streams. Unlike public APIs, which are open to all, and private APIs, which are internal, partner APIs are shared with select partners, benefiting both parties through tailored integrations. Examples such as eBay and Walgreens demonstrate how partner APIs can generate substantial revenue by sharing profits with developers, while industries like automotive and telecom effectively leverage APIs to foster innovative collaborations. Regulatory pressures in sectors like banking and healthcare have also led to the adoption of partner APIs, allowing organizations to meet legal requirements while uncovering new business opportunities. To maximize the value of partner APIs, companies should carefully manage data exposure, partner selection, and security measures, ensuring a strong developer experience to facilitate integration. As the digital economy grows, partner APIs are becoming increasingly vital, forming the backbone of interconnected ecosystems across various industries.

The text announces the release of the OpenAPI 3.1 Cheat Sheet, a concise and comprehensive guide designed to aid the community in effectively using OpenAPI by providing a hand-held reference. After six months of development, involving collaboration with OpenAPI experts and key users, the Cheat Sheet condenses the complex OpenAPI Specification into manageable sections such as Document Structure, API Structure, and Security. The resource is freely available under a CC BY-NC-SA 4.0 license and is intended to be accessible in both printed and PDF formats. The creators plan to continue refining this version, addressing any errors identified, and expanding its scope to include future OpenAPI versions and a web version. They encourage sharing the guide widely to benefit the entire OpenAPI community.

For Pride Month this year, Bump.sh opted for a different approach by not adopting the customary rainbow-colored logos, which have been a mix of genuine support and pinkwashing by various companies in recent years. This decision aligns with their commitment to inclusivity and support for LGBTQIA+ communities, particularly the trans community, which faces significant challenges and attacks globally. While many companies have refrained from using Pride-themed branding, Bump.sh chose to express their support through a blog post and by actively supporting organizations that assist LGBTQIA+ individuals. They have also committed to matching donations made by team members to these organizations, emphasizing the importance of genuine connection and support over symbolic gestures.

API Code-first is a method of building APIs by first creating the API and then using annotations to generate API documentation in formats like OpenAPI, with Springdoc being a popular tool for this in Spring applications. The process involves setting up prerequisites such as Java 21, Maven or Gradle, and a Spring Boot application, followed by installing the Springdoc dependency and configuring it to generate OpenAPI descriptions. This initial setup allows for basic OpenAPI description generation, which can be improved by adding Java annotations to provide more context and detailed information about API operations, parameters, and responses. Annotations such as @Operation, @Tag, and @Parameter are used to enrich the documentation with summaries, descriptions, and parameter details, making it more useful for API consumers. The guide also covers deploying the OpenAPI description to Bump.sh, a platform for hosting and viewing API documentation, and suggests automating the deployment process through CI/CD pipelines to ensure the documentation remains up-to-date with any changes in the API code.

The text discusses the importance of documenting APIs and compares several popular tools used for this purpose, highlighting their features, pros, and cons. It emphasizes that good API documentation enhances user integration, reduces support calls, and aids in onboarding new team members. Among the tools reviewed, Bump.sh, Redoc, Scalar, Stoplight Elements, and ReadMe are evaluated based on their functionality, customization options, and suitability for different user needs. Bump.sh is noted for its flexibility in API catalogs and integration into existing workflows, while Redoc is praised for its UI customization capabilities. Scalar is positioned as a tool for developers with a focus on open-source, while Stoplight Elements offers beautiful, interactive documentation. ReadMe supports a wide range of documentation types and developer engagement tools, though its pricing can be high. The text ultimately suggests that the choice of tool depends on specific requirements such as performance, integration with Git workflows, and the ability to handle complex API ecosystems.