java把swagger轉json的簡單介紹

本文目錄一覽：

• 1、swagger返回json注釋應該怎麼寫
• 2、swagger怎麼根據java生成json
• 3、swagger能轉化為pdf嗎

swagger返回json注釋應該怎麼寫

“definitions”: {

“ownerNumer”: {

“type”: “object”,

“properties”: {

“status”: {

“type”: “integer”,

“format”: “int64”,

“description”: “狀態:0正常1異常”

},

“number”: {

“type”: “integer”,

“format”: “int64”,

“description”: “用戶數量”

}

}

}

},

swagger怎麼根據java生成json

WebAPI文檔工具列表Swagger——Swagger框架可以通過代碼生成漂亮的在線API，甚至可以提供運行示例。支持Scala、Java、Javascript、Ruby、PHP甚至Actionscript3。在線Demo。I/ODocs——I/ODocs是一個用於RESTfulWebAPIs的互動式文檔系統

swagger能轉化為pdf嗎

我們在項目開發完成，介面寫好後，需要將介面文檔給到前端同學，或者合作方的工程師。但 swagger 對介面閱讀並不友好，大部分情況下還得把服務啟動好才能訪問。這篇文章給各位開發人員介紹如何使用 docway 將 swagger 導出 PDF 或者 markdown 。

第一步：準備 swagger json

打開 swagger ui 的頁面

點擊 swagger json 的鏈接（可能沒有顯示該鏈接）

請點擊輸入圖片描述

請點擊輸入圖片描述

如果你的 swagger 頁面沒有顯示該鏈接，F12打開開發者工具，重新刷新後，複製 api-docs 的響應內容。

請點擊輸入圖片描述

請點擊輸入圖片描述

在彈出的tab頁中或者 api-docs 的內容，複製下來或者保存到本地文件中

第二步：將 swagger json 導入 docway

登錄

在控制台中，新增項目，選擇 導入

選擇 swagger 導入，並根據自己的 swagger json 選擇是「上傳文件方式」還是「粘貼json方式」

請點擊輸入圖片描述

請點擊輸入圖片描述

導入後，便可以看到項目信息了

請點擊輸入圖片描述

第三步：導出 PDF markdown

在項目的「更多設置」中，找到「項目導出」功能。可以選擇 PDF Markdown 導出。

請點擊輸入圖片描述

docway 是一款在線介面文檔管理工具，除了 PDF markdown 導出， 還支持介面設計、介面分享、介面mock、介面歷史記錄、介面版本管理、團隊管理等功能。