Swagger 是一套工具,用於設計、描述和文檔化 RESTful API。本教程將探討如何使用 Java 解析 OpenAPI 文檔文件並提取其各個組件。Swagger 基本上是一套開源規則、規範。
知識庫 / REST / OpenAPI RSS 訂閱
開放API自定義生成器
本教程將繼續探索 OpenAPI Generator 的自定義選項。我們將演示如何創建新的生成器,以生成基於 Apache Camel 的應用程序的 REST Producer 路由。
使用 OpenAPI 生成器實現開放 API 服務器
開放API生成器(OpenAPI Generator)根據名稱推斷,可以從OpenAPI規範生成代碼。它能創建客户端庫、服務器樁、文檔和配置。支持多種語言和框架。尤其有支持…
OpenAPI JSON 對象作為查詢參數
本教程將介紹如何使用 OpenAPI 處理 JSON 對象作為查詢參數。OpenAPI 2 不支持 JSON 對象作為查詢參數,僅支持原始值和原始值的數組。因此,我們將...
使用 OpenAPI 和 Lombok 註解生成模型
Lombok 是一款 Java 庫,旨在減少樣板代碼,如獲取器、設置器等。OpenAPI 提供了一個屬性,用於使用 Lombok 註解自動生成模型。本教程將探索如何使用 Lombok 註解生成模型。
Spring Cloud Gateway 與 OpenAPI 集成
API 文檔是構建健壯 REST API 的關鍵組成部分。我們可以基於 OpenAPI 規範實現 API 文檔,並在 Spring 應用中使用 Swagger UI 進行可視化。API 端點也可以通過 API 進行暴露。
Spring Boot 所有端點獲取
在與REST API交互時,通常需要獲取所有REST端點。例如,我們可能需要將所有請求映射端點保存到數據庫中。本教程將介紹如何在Spring Boot應用程序中獲取所有REST端點。
修改 Swagger-UI URL 前綴
作為優秀的開發者,我們知道文檔對於構建 REST API 至關重要,因為它幫助 API 的消費者能夠無縫工作。 如今,大多數 Java 開發者都在使用 Spring Boot。 目前,兩個工具簡化了 API 的生成和維護。
使用默認全局安全方案 in springdoc-openapi
本教程將指導您配置默認全局安全方案並在 Spring MVC Web 應用程序中使用 springdoc-openapi 庫作為 API 的默認安全要求。同時,還將討論如何覆蓋這些設置。
Swagger API 響應對象集
本教程將教你如何修改 Swagger API 響應。首先,我們將介紹 OpenAPI 規範和 Swagger API 響應。然後,我們將使用 Spring Boot 實現一個簡單的示例,用於記錄 Spring REST API。
使用 Spring Boot 和 Swagger UI 設置 JWT
本教程將介紹如何配置 Swagger UI 以在調用我們的 API 時包含 JSON Web Token (JWT)。我們將使用 springdoc-openapi-ui,它包含了所有必要的依賴項,以便開始使用 Swagger。
Spring REST Docs 與 OpenAPI
Spring REST Docs 和 OpenAPI 3.0 都是為 REST API 創建 API 文檔的兩種方法。 本教程將探討它們各自的優缺點。 Spring REST Docs 是由 Spring 社區開發的框架,用於創建…
基於Spring Boot和OpenAPI 3.0的API先行開發
軟件工程行業越來越依賴Web API。雲計算和HTTP的日益普及可能對此有解釋。軟件開發團隊必須確保設計出有益且用户友好的API。主要挑戰……
從 Swagger 文檔中隱藏 Spring Boot 端點
在創建 Swagger 文檔時,我們經常需要隱藏某些端點,防止端點被最終用户暴露。最常見的情況是,當端點尚未準備好時。我們還可以有私有端點,不想暴露這些端點。
從 OpenAPI 規範生成 Spring Boot 中的 HTTP 客户端
在本文中,我們將學習如何自動生成服務器端代碼,以實現網絡通信需求。通常,在需要網絡通信的服務中,我們需要編寫服務器和客户端代碼以啓用這些通信。
使用JWT身份驗證配置OpenAPI
OpenAPI 是一種語言無關、平台無關的規範,它對 REST API 進行標準化。OpenAPI 使得用户無需深入瞭解代碼即可輕鬆理解 API。Swagger-UI 從 OpenAPI 中生成可視化文檔。
Swagger @Api 描述已過時
描述 RESTful API 在文檔中扮演着重要角色。 Swagger 2 是一種常用的用於文檔 RESTful API 的工具。 然而,一個有用的屬性已被棄用。 本教程將介紹一種解決方案。
OpenAPI 生成器自定義模板
OpenAPI Generator 是一款工具,可快速從 REST API 定義生成客户端和服務器代碼,支持多種語言和框架。雖然生成的代碼通常可以直接使用,無需修改,但...
Swagger Codegen 自定義驗證
當我們需要使用 Swagger 生成驗證時,通常會使用基本規範。然而,我們可能需要添加 Spring 自定義驗證註解。本教程將教你如何使用這些驗證生成模型和 REST API。
OpenAPI 文件中的日期處理
本教程將介紹如何在 OpenAPI 文件中聲明日期,這裏以 Swagger 為例。這將允許我們以標準化的方式管理調用外部 API 時輸入和輸出的日期。Swagger 是一套工具,用於實現……
從 Swagger API 文檔生成 PDF
本教程將介紹多種從 Swagger API 文檔生成 PDF 文件的方法。為了熟悉 Swagger,請參考我們關於使用 Swagger 2 與 Spring REST API 集成的教程。第一種解決方案是生成 PDF 文件…