簡體   English   中英

如何在“swagger-ui/index.html”中顯示手動生成的 OAS

[英]How to display a manually generated OAS in "swagger-ui/index.html"

我創建了一個 REST API 和 Spring Boot 作為新兵訓練營的項目。

完成后,我決定記錄端點並找到“springdoc-openapi-ui”(我理解它是為了根據我的項目代碼自動創建文檔)

問題是,我發現結果非常令人失望,所以我從“/v3/api-docs/”中取出 JSON,並將其粘貼到在線Swagger 編輯器

Once I finished creating a beautiful documentation I realized I don't know how to make the "swagger-ui/index.html" point to my swagger.json or swagger.yaml automatically. 我已經閱讀了 Swagger UI 配置指南,我可以創建一個“swagger-configuration.YAML”文件並定義一個名為 spec 的參數,我可以在其中指向我的 JSON ZA8CFDE6331BD59EB2AC96F8911C4B66不知道將文件放在哪里以及所述配置的語法)我在此頁面某處讀到的另一個選項(現在找不到)是將 JSON 嵌入 index.html 作為腳本,但沒有示例關於如何正確地做

這是手動創建我的文檔的重點

我會很感激任何幫助,我希望我已經清楚地解釋了我在尋找什么。

我找到了從Springdoc.org 中提取的解決方案 - 常見問題解答

如果您的文件 open-api.json 包含 OpenAPI 3 格式的 OpenAPI 文檔。 然后簡單地聲明:文件名可以是任何你想要的,從你聲明的那一刻起,你的聲明是一致的 yaml 或 json OpenAPI Spec。

springdoc.swagger-ui.url=/open-api.json

然后文件 open-api.json,應該位於:src/main/resources/static 不需要額外配置。

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM