May 2023 Summaries

The Postman Open Technologies Knowledge Base project involves developing a Knowledge Base API, with the initial focus on conducting a strategy step that includes interviewing API stakeholders. This process revealed valuable insights into the needs and challenges of various user personas, such as API designers, researchers, product managers, and technical architects, which helped validate assumptions and identify new opportunities for product development. The interviews aimed to understand each persona's jobs-to-be-done, the tools and services they use, and the potential benefits they could gain from the API. By gathering feedback from real users, the project aims to design an API that effectively addresses user pain points and seamlessly integrates with existing workflows, thereby enhancing user efficiency and satisfaction.

A new Travel API category has been launched, aimed at transforming the development of travel-related applications by providing comprehensive access to a wide range of travel data and services from various sources. This curated collection of APIs includes offerings such as Amadeus for Developers’ Public Workspace, which provides data on flights, hotels, and car rentals, and APItude by Hotelbeds, which offers a vast inventory of accommodations. Other notable APIs include Duffel for flight booking, Emerging Travel Group’s Public Workspace for integrating travel services, and IATA APIs for flight schedules and ticketing information. These APIs are designed to streamline the creation of travel platforms by allowing developers to access real-time data, enhance search and booking capabilities, and offer personalized itineraries, all backed by comprehensive documentation and technical support. The initiative encourages developers to explore the Postman Public API Network and leverage these tools to build seamless and efficient travel applications.

Postman has successfully partnered with the Birla Institute of Technology and Science, Pilani (BITS Pilani) over the past year to enhance API literacy and foster innovative research and development. The collaboration has resulted in significant achievements, including the participation of over 5,000 students in Postman Classroom Program bootcamps, enabling students to earn Postman Student Expert badges. Additionally, the partnership facilitated the launch of API Lab projects, where a team of 30 students worked on diverse engineering projects, supported by a high-end computer lab at BITS Pilani. The collaboration also expanded API literacy beyond BITS Pilani, reaching a global audience through remote hackathons and regional events like API Day Pilani. Looking ahead, Postman aims to continue this partnership to further impact student learning and development within the API community.

Abir Pal, a Postman Student Leader since 2021 and a software engineer at GetCerta.com, reflects on his impactful journey within the Postman community, emphasizing the role of student communities in personal and professional development. He credits the Postman Student Program for offering an inclusive environment that enhances API literacy through training sessions, networking opportunities, and mentorship from industry professionals. Abir highlights the unique support from the program's dedicated members, such as personalized interactions with Postman's CEO and training in job-search strategies, which he found instrumental in advancing his career. His initiatives, like organizing the API Hacks 2.0 hackathon, served to promote API literacy and resulted in students securing job offers, showcasing the tangible benefits of engagement in student-led events. Abir advises aspiring Student Leaders to focus on effective communication, staying updated on API knowledge, and fostering an inclusive and collaborative atmosphere to maximize their influence and career growth.

API governance emphasizes the importance of consistency across multiple dimensions to maximize the value generated by APIs. Achieving consistent APIs involves ensuring coherence within individual APIs, across an organization, with domain-specific practices, with global practices, and with established standards. Internally consistent APIs allow users to easily understand the relationships between inputs, outputs, and operations, while organization-wide consistency helps users leverage their experience with one API to understand others more quickly. Consistency with domain practices requires balancing domain conventions with user accessibility, while alignment with global practices encourages using familiar patterns rather than creating new ones. Adhering to standards ensures predictable behavior and interoperability with existing tools, although it may sometimes conflict with user-friendliness for non-experts. Finding the right balance in these dimensions is crucial for creating scalable, efficient, and user-friendly APIs.

Enterprise organizations often maintain API catalogs as part of their management solutions, yet they face challenges in keeping these portals current and effective due to rapid development and decentralized operations. Common issues include outdated, incomplete, or overly technical documentation, and a lack of business context, which can hinder API consumer engagement. These challenges are exacerbated by quick delivery demands, underutilization due to lack of awareness, and bottlenecks introduced by management gatekeepers. To address these issues, forward-thinking companies are innovating by enhancing collaboration via API workspaces, using modular collections, and employing "Run in Postman" buttons to streamline interactions. They are also expanding engagement beyond traditional portals using various online platforms and networks. This approach allows companies to create a more holistic experience for API consumers, ensuring their API operations are accessible through multiple channels and complement existing API portals, as demonstrated by leaders like Salesforce, Twilio, and Stripe.

The importance of well-designed API experiences was discussed in a Postman Intergalactic session with API Handyman, Arnaud Lauret, emphasizing that good API design is crucial for businesses to remain competitive as APIs serve as the backbone for web and mobile applications. Effective API experiences enhance usability, reusability, and reduce time and risk in delivering high-value APIs, whereas poor API experiences can lead to increased costs and decreased productivity. A Coffee Brewing API was used as a practical example to illustrate ideal API design, demonstrating how a GET request can list coffee beans and a POST request can brew coffee. Consistent naming conventions were highlighted as integral to user-friendly API design, stressing that endpoint, method, and response code naming should be consistent to facilitate understanding and usability, with a specific example given to avoid mixing singular and plural forms. Additionally, choosing appropriate data types can improve the performance, reliability, and security of APIs, thereby enhancing the overall user experience.

API developer portals have evolved from a nascent concept in the early 2000s to a crucial component for API producers by 2020, serving as a bridge between providers and consumers by offering essential information and tools for API utilization throughout its lifecycle. These portals, distinct from API marketplaces, provide specific resources for developers to understand, test, and integrate APIs, while marketplaces showcase various APIs to potential users at scale. As enterprises face the challenge of managing an increasing number of APIs, traditional portals are complemented by platforms like Postman, which offer flexible solutions through public and private networks, workspaces, and collections, enhancing consumer engagement and reducing friction in accessing APIs. Postman’s collaborations with companies like Twitter, Salesforce, and ShipEngine illustrate diverse integration strategies that utilize the Postman API Network to optimize the developer portal experience. The evolving landscape demands that API producers engage consumers through multiple channels beyond a single portal, emphasizing the need for a distributed and adaptable approach to API management that aligns with the rapid expansion of digital ecosystems and the diverse expectations of API consumers.

Postman Open Technologies Knowledge Base is a project designed to provide insights about APIs available online, with one of its key objectives being the development of an API for consumers to access this information. The creation of the Knowledge Base API follows the Postman team's internal API Design Playbook, which includes steps like strategy, definition, validation, and specification. The strategy step involves documenting the API's purpose and identifying user personas such as technical researchers, API designers, product managers, and technical architects through interviews to understand their needs and challenges. These personas are fictional characters representing potential API users, each with specific jobs-to-be-done, benefits, behaviors, and challenges. Understanding these personas allows the API designer to tailor the API's architecture, capabilities, resources, and operations to meet real user needs effectively. This user-centered approach ensures that the API directly addresses user problems and objectives, increasing the likelihood of its adoption and success.

GraphQL, introduced by Facebook in 2015, is rapidly becoming a popular choice for data delivery in applications, with Gartner predicting over 50% of global enterprises will have implemented it as their internal data layer by 2025. Emerging trends in GraphQL APIs, such as GraphQL federation, real-time data subscriptions, advanced tooling, schema-first development, and security enhancements, are shaping the way developers create and manage these APIs. Tools like Postman's GraphQL client, Relay, and Urql are simplifying integration, while security techniques like query cost analysis and persisted queries protect against malicious activities. Additionally, partial query results and the increasing use of compilers enhance the resilience and performance of GraphQL APIs, while custom directives offer flexibility for developers to build sophisticated solutions. As these innovations continue to evolve, they are poised to significantly enhance the performance, flexibility, and user experience of GraphQL APIs, driving digital transformation efforts across various industries.

Postman announced its participation as a mentoring organization in the 2023 Google Summer of Code (GSoC), selecting a talented group of contributors to work on nine projects focused on open source API technologies. The projects span across the AsyncAPI Initiative, OpenAPI Initiative, and JSON Schema, aiming to enhance tools and specifications in these areas. The selected contributors will work on projects such as automating technical steering committee listings, introducing UI tests for AsyncAPI, developing an OpenAPI web search engine, and creating data transformation utilities using JSON Schema. The program promises a rich learning experience, with contributors receiving guidance from experienced mentors and resources from Postman, fostering contributions to the API-first world.

Postman has introduced a beta version of its VS Code extension in 2023, aiming to integrate seamlessly into developers' workflows by allowing them to design, develop, and test APIs directly within their IDE. This initial release focuses on providing a core API client experience, enabling users to send API requests across protocols like HTTP, gRPC, and WebSocket without needing to toggle between their IDE and Postman. The extension is available for installation from the VS Code marketplace, and Postman plans to introduce more protocols and features over time, including support for Postman Collections and environments. They encourage user feedback to refine the extension further.

The past decade has seen significant technological shifts, notably with the widespread adoption of cloud technology and the rise of generative AI, prompting Postman to evolve its API platform to meet current demands. Originally a simple Chrome extension for sending API calls, Postman has grown to offer comprehensive cloud-based services and team collaboration features, but this evolution created complexity and the challenge of maintaining dual architectures for local and cloud-based capabilities. To streamline operations and enhance efficiency, Postman is retiring its Scratch Pad mode in favor of a unified architecture with a new lightweight API client designed for quick API calls, while encouraging users to migrate to cloud-powered workspaces. This shift facilitates faster feature development, supports new protocols like GraphQL and gRPC, and enhances data security through robust measures and compliance with global standards. Postman is committed to ensuring a seamless transition for users, offering tools and support for data migration, and prioritizing security across its platform, which is now home to over 25 million developers.

Postman workspaces are collaborative environments that facilitate problem-solving and organization for both individual developers and teams, with options including personal, team, partner, and public workspaces. These workspaces are used for various API-related tasks such as onboarding engineers, setting up API tests, and managing incident responses, but setting them up effectively can be complex and unclear. To address this, Postman has introduced workspace templates that streamline setup and enhance team collaboration by providing tailored templates for common API challenges, including engineering onboarding, API testing, incident response, infrastructure management, API demos, and API security. Each template includes a Workspace Overview and relevant collections that can be customized to fit specific team needs, and Postman is seeking user feedback to expand template offerings.

To enhance the adoption of a world-class API, it is crucial to ensure its discoverability through effective search engine optimization (SEO) strategies, as over 25 million developers use platforms like Postman to find APIs. Key steps include establishing a public workspace for the API on the Postman API Network, crafting detailed and introductory content to aid first-time users, and maintaining a complete public profile with essential components like images, descriptions, and links to social and GitHub profiles. Detailed, accurate documentation enriched with relevant links is vital for usability and accessibility, while keeping all content up-to-date ensures a positive user experience. Additionally, sharing and linking Postman assets across reputable, relevant sources can significantly boost search engine rankings, as these backlinks are considered endorsements of the content's quality. Although improvements in ranking and API adoption from SEO efforts may take time to manifest, these strategies offer a scalable approach to increasing visibility and generating value from the API.

Leading Postman's Open Technologies Program Office, the author emphasizes the critical role of documentation in engineering, OSPOs, and developer relations, advocating for its prioritization despite the lack of immediate rewards compared to coding or problem-solving. They argue that effective documentation serves as a compassionate act, benefiting both current and future collaborators by reducing frustration and enhancing communication. The author outlines how documentation increases professional value, builds personal brand and internal visibility, facilitates content creation, and aids in knowledge retention and storytelling, ultimately saving time and encouraging collaboration. While acknowledging that not all documentation needs to be perfect, they stress that even average documentation can effectively serve its purpose and should always be prioritized.

Generative AI is revolutionizing human-computer interaction by enabling computers to perform creative tasks beyond traditional deterministic functions, with tools like ChatGPT illustrating this shift. This advancement is anticipated to transform software development, as AI-driven bots become integral to user interfaces, simplifying complex tasks previously requiring extensive training. The role of APIs is crucial in this ecosystem, acting as the connecting framework that allows these AI bots to perform actions. Organizations must prioritize API design and strategy to remain relevant, as poorly designed or nonexistent APIs will limit their visibility to AI technologies. While generative AI offers substantial opportunities, it also brings challenges, such as the potential for misinformation and the necessity for regulatory frameworks. As AI models often rely on publicly available data, organizations that possess or curate valuable proprietary data are in a strong position to capitalize on this trend. However, human oversight remains essential for verifying AI outputs and minimizing the risk of errors.

API governance seeks to maximize the value of APIs by ensuring users understand their importance and the supportive role governance plays, rather than acting as a regulatory force. To achieve this, API advocacy is essential, focusing on raising awareness, demystifying governance, and engaging relays and sponsors to spread the message. Raising awareness involves educating IT teams and business executives on the benefits and risks associated with APIs, emphasizing their impact on business performance and IT systems. Demystifying governance includes clarifying its benefits, offering services like API reviews and training, and demonstrating tools that simplify API management. Engaging key stakeholders—such as API-savvy developers, tech leads, and supportive managers—helps amplify the message and increase acceptance of governance by showcasing successful API implementations and encouraging best practices throughout the organization.

The rapidly evolving landscape of AI foundation models is marked by two major philosophical frictions: the dichotomy between massively large and smaller models, and the tension between open-source and commercial API-based distribution. Foundation models, which serve as a general-purpose basis for a diverse range of AI applications, are pre-trained on extensive data and can be fine-tuned for specific tasks. Large-scale models, such as OpenAI's GPT-3 and Google's BERT, traditionally outperform smaller models but are now being challenged by compact models like LLaMA, which offer comparable performance with greater efficiency. These smaller models are more accessible for deployment on devices with limited resources. Another significant debate centers around the distribution of these models, with commercial APIs like GPT-4 and LaMDA contrasted against open-source options like Dolly 2 and Stable Diffusion, raising issues of fairness, safety, and accessibility. The interplay between model size and distribution method has created distinct factions, with large models typically aligned with commercial APIs and smaller models often associated with open-source approaches. These frictions are expected to continue influencing the development, distribution, and adoption of foundation models, necessitating careful consideration by stakeholders as the technology advances.