Stoplight 與 Postman:完美協作

作者:szSun · 2024-09-02 · 閱讀時間:9分鐘

設計并交付更好的API:兩款頂級工具的強強聯合

對于API工具需求,沒有一種“一站式解決方案”。如果有的話,您肯定早已知曉。現實情況是,每個API項目都有不同的需求,這意味著每個API團隊都必須找到適合任務的一套工具。幸運的是,精心挑選的工具箱通常比全生命周期解決方案更具成本效益,也更靈活且功能更強大。

Stoplight和Postman常常被視為互斥的API管理工具,但我們最近對客戶進行的一項調查顯示,許多公司都在結合使用這兩種工具,以實現最佳的組合。這種方法是合理的——兩款產品都相對輕量且成本低,并且盡管在某些功能上有所重疊,但它們各自在API產品生命周期的不同階段提供了專業化的功能。Postman是一款業界標準的技術工具,廣泛應用于開發和測試階段以及基本的技術文檔編寫。Stoplight支持一些相同的功能,但它圍繞“API即產品”的原則構建,提供頂級的設計和文檔功能,為API消費者帶來最佳體驗。

我們最近采訪了兩位既使用Stoplight又使用Postman的客戶,了解他們如何在API項目中結合這兩種工具。Pete Walton是Sardine的首席銷售工程師,Sardine是一家為金融行業客戶提供統一API的反欺詐和合規引擎,這些客戶以前必須從各種來源收集信息。我們還采訪了Akshay Bhalotia,他是一位開發者體驗顧問,最近任職于Phyllo,這是一款標準化的API,用于從創作者經濟平臺提取數據。盡管這兩家公司截然不同,但我們發現他們在使用這些工具時有一些共同的模式。

第一階段:通過Postman賦能技術團隊

既使用Stoplight又使用Postman的客戶通常采用相同的方法——Postman是內部工具,而Stoplight則讓他們能夠更有效地滿足客戶需求。

Postman是一款出色的API開發團隊生產力工具——它為技術用戶進行了優化,并能高效地滿足他們的需求。Sardine的員工是技術熟練的人員,如數據分析師、開發人員和技術銷售團隊。因此,他們廣泛使用Postman進行內部測試,并在初始集成階段為新客戶提供實際操作支持。根據Walton的說法,他們確實會將Postman Collections直接分享給特定用戶,主要是那些負責構建自定義請求和集成的企業級客戶。對于技術思維導向的用戶,無論是內部還是外部,Postman都是一個高效且熟悉的工具。

Phyllo使用Postman的方式略有不同,但指導理念仍然相同。正如Bhalotia所說:“任何曾經與API打交道的開發者都聽說過并使用過Postman。”對他來說,使用Postman作為Phyllo的分發渠道幾乎是一個必要條件——許多開發者,無論是內部的還是外部的,都會希望能夠使用它來探索和測試新的API產品。

第二階段:通過Stoplight優先考慮消費者

并非所有客戶都具備技術熟練度,因此您需要能滿足他們需求的工具。Postman非常適合測試API,但在初始設計過程中,它沒有專門的支持。而在與API消費者進行集成后的持續支持關系中呢?這些都是Stoplight擅長的領域——設計和文檔。

通過設計優先工具構建更好的產品

Walton和Bhalotia都強調了客戶需求如何驅動他們的工具和流程選擇。Walton多次提到,為API消費者提供直觀的用戶體驗對于吸引和留住用戶至關重要。設計優先幾乎是Stoplight的一個信條,選擇用他們的工具開始您的API設計流程將有助于實現您期望的結果。正如Bhalotia指出的那樣:“Stoplight擁有最好的OpenAPI兼容的基于UI的API架構構建器之一,使得在API設計上進行協作和討論變得非常容易。”如果您重視良好的產品設計,那么使用與這些原則一致的工具是合乎邏輯的。

除了使用Stoplight Studio,這些公司還發現了Stoplight工具幫助他們滿足設計需求的其他方式。Phyllo正在開始實施自動化風格指南,作為其對用戶體驗重視的一部分,幫助提供更一致的API產品,并進一步改善開發者體驗。對于Sardine而言,在高度監管的金融科技行業中,嚴格的訪問控制是必需的。他們發現Stoplight的團隊功能在確保客戶僅能訪問他們需要的數據和文檔方面非常有用。

提供有效的用戶文檔

在我們的討論中,Pete Walton描述了某些客戶在看到“過于技術化”的工具時會感到不知所措。即使是經驗豐富的開發人員,有時也會覺得API文檔過于復雜且難以理解。Sardine和Phyllo都在使用Stoplight提供更“友好”且更容易接近的文檔。

Walton和Bhalotia都提到他們非常贊賞在Stoplight文檔中包含可用代碼示例的便利性。對于Sardine來說,特別重要的是,Stoplight文檔可以獨立于代碼庫進行托管。他們需要對代碼和數據進行嚴格控制,但仍允許潛在用戶在文檔中探索真實的產品功能。Stoplight為他們提供了這種控制權,同時還提供了流暢、直觀的用戶界面。如前所述,Walton有時會為客戶直接提供Postman的訪問權限,但“百分之九十九的時間,Sardine的銷售團隊只是將客戶添加到相關的Stoplight團隊中”,以便他們獲得所需的文檔訪問權限。

通過組合式商業模式高效構建

COVID-19大流行迫使各類組織迅速調整。許多商業和技術領導者發現了組合式商業模式的價值。簡而言之,這意味著將產品的核心產品和功能分解為獨立、可配置的部分,隨著業務條件的變化,這些部分可以重新部署為新的形式。到了2023年,隨著市場條件促使許多公司追求更精簡、更高效的運營,這一目標仍然具有重要意義。

如果您認為組合式商業模式并不革命性,那可能是因為對于大多數開發團隊來說,這并不是一個新想法。新的是人們越來越認識到這種模式不僅在技術工具上有價值,還可以作為任何行業中構建更好產品和服務的基礎。將API視為完整的產品,并讓客戶需求直接反饋到API設計中,使公司能夠更快、更高效地提供價值。

Stoplight和Postman提供了無縫集成的互補功能。每個工具本身都是組合式商業模式的例子,這意味著它們為用戶提供了更大的價值。它們也是構建您自己的組合式API項目的堅實基礎,因為它們使您的流程更加靈活高效,并讓您更專注于用戶需求。

精簡工具

Stoplight和Postman都是“少即是多”工具包中的工具。為了最大化它們的價值,您需要投入時間來理解您的API開發流程,了解您的API產品在哪些方面需要特殊支持,并評估您的開發團隊的知識和優勢。您是否確切了解您的工具需求在哪里?當您了解后,您可以選擇定制的解決方案,避免在與您的特定需求不匹配的工具上浪費資源。

一般而言,像Stoplight和Postman這樣能夠輕松與其他系統集成的工具,通常會比臃腫的“一站式”系統更好的選擇。Walton強調說,總體價格和價值在選擇Stoplight和Postman時是重要的考量因素,而不是選擇捆綁功能的競爭對手。作為一個處于充滿新挑戰和復雜挑戰的行業中的創業公司,Sardine優先考慮保持低成本,以便其能夠專注于核心產品。組合式企業需要靈活、跨兼容的流程和工具,使他們能夠在不削減利潤的情況下進行創造和創新。

更敏捷的產品

組合式商業模式還涉及通過API項目所生產的內容,而靈活的工具對此也有幫助。隨著您的開發流程變得更加精簡,您將處于更好的位置,以快速調整以滿足客戶需求,這正是這種商業模式的標志。Bhalotia在談到他選擇正確工具的原則時提到了這一點:“對我來說,最重要的兩件事是為客戶提供的用戶體驗和我的工程團隊的生產力,按此順序排列。”Postman支持內部生產力,Stoplight為您的API消費者提供出色的用戶體驗。兩者結合在一起,是實現這些目標的絕佳組合。

“更敏捷”意味著變得更加靈活,隨時準備快速適應變化。您希望您的API項目準備好迎接挑戰,以便在條件變化時,您仍然能夠持續提供最佳用戶體驗。使用模塊化、精簡的工具,您可以將精力集中在理解和適應客戶需求上,并確保您的工具不會妨礙流程和產品中的創新。

更快完成產品

正如Bhalotia所說,Postman是API開發者和消費者的重要工具。然而,并不是所有API都能成為成功的API產品,而這正是組合式商業所需要的。僅依賴一款工具可能不足以實現您的期望結果。Stoplight通過在產品生命周期中將技術資源與用戶聯系起來,填補了阻礙一個好API成為一個偉大產品的關鍵空白。

構建耐用而靈活的API產品需要經過深思熟慮的設計、精簡的流程和精心選擇的工具。這要求您將API視為不僅僅是技術資源,這意味著在設計和開發過程中要時刻考慮用戶體驗。

一個API產品的完成并不是所有端點都通過測試,或第一個客戶成功創建集成時。完成的產品包括文檔和支持,以及整合反饋和數據以優化設計并為下一次迭代做好準備的流程。Postman和Stoplight一起組成了一套高效且靈活的工具,支持您整個過程。

文章來源:Stoplight AND: Playing well with Postman