[Firebase] Android stduio Firebase 安裝教學詳細圖解 | firebase教學android
為了讓其他開發人員能夠串接我們後端程式的API,我們需要提供說明文件,而這個很繁瑣的文件撰寫流程可以透過一些工具解決,例如本次要介紹的springdoc套件,能夠依據專案程式自動產生OpenAPI文件。註:springdoc是基於OpenAPI3.0(Swagger3),如果需要產生Swagger2可以使用SpringFox延伸閱讀:OpenAPI和Swagger是什麼?他們是什麼關係?Swagger規範和工具不同嗎?引用依賴如果是使用Maven的話先在pom.xml引用依賴:
為了讓其他開發人員能夠串接我們後端程式的 API,我們需要提供說明文件,而這個很繁瑣的文件撰寫流程可以透過一些工具解決,例如本次要介紹的 springdoc 套件,能夠依據專案程式自動產生 OpenAPI 文件。 註: springdoc 是基於 OpenAPI 3.0 (Swagger 3), 如果需要產生 Swagger 2 可以使用 SpringFox 延伸閱讀: OpenAPI 和 Swagger 是什麼?他們是什麼關係?Swagger 規範和工具不同嗎? 引用依賴 如果是使用 Maven 的話先在 pom.xml 引用依賴: <dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-ui</artifactId> <version>1.6.8</version> </dependency> 如果不是 Maven 的可以查看 mvnrepository 查看 API 文件 只要引用依賴之後就已經自動產生完畢了,執行後可以使用下列網址查看自動產生的文件 預設查看定義文件(JSON): http://localhost:8080/v3/api-docs 預設查看定義文件(yaml): http://localhost:8080/v3/api-docs.yaml Swagger UI: http://localhost:8080/swagger-ui/index.html 如果覺得每次都要輸入這麼長的網址才能開啟 Swagger UI 頁面,可以在設定檔中設定路徑別名 依照下面的設定,以後在網址中輸入 http://localhost:8080/su 時就會被自動跳轉到 Swagger UI 頁面 springdoc.swagger-ui.path=/su 增加自訂說明文字 雖然目前已經能夠...