swagger工具簡介

2022-06-14 23:12:09 字數 1540 閱讀 5449

swagger是全球最大的openapi規範（oas）api開發工具框架，支援從設計和文件到測試和部署的整個api生命週期的開發。簡單點說，就是按照swagger的規範書寫介面，swagger會自動幫你生成介面文件、以及介面的測試

將swagger整合到spring boot專案中

1、配置依賴的包

<


dependency


>


<


groupid


>io.springfox


groupid


>


<


artifactid


>springfox-swagger2


artifactid


>


<


version


>2.4.0


version


>


dependency


>


<


dependency


>


<


groupid


>io.springfox


groupid


>


<


artifactid


>springfox-swagger-ui


artifactid


>


<


version


>2.4.0


version


>


dependency


>
2、swagger配置檔案

@configuration


@enableswagger2


public


class


swaggerconfiguration 


/*** 構建 api文件的詳細資訊函式,注意這裡的註解引用的是哪個


* @return


*/private


apiinfo apiinfo()


}
3、對於介面的配置--基於註解

@api()用於類：表示標識這個類是swagger的資源 不標識也無所謂

@api(value="使用者controller",tags=)
@apioperation()用於方法； 表示乙個http請求的操作  不標識也無所謂

@apioperation(value="根據使用者編號獲取使用者姓名", notes="test: 僅1和2有正確返回")
@apiimplicitparam() 用於方法 表示單獨的請求引數 

@apiimplicitparam(paramtype="query", name = "usernumber", value = "使用者編號", required = true, datatype = "integer")
@apiimplicitparams() 用於方法，包含多個 @apiimplicitparam

@apiimplicitparams()
4、效果展示

Swagger 後端文件生成工具

在公司的專案中通常使用 swagger，由後端來模擬業務資料。swagger 是乙個 rest apis 文件生成工具，它從 注釋中自動生成文件，可以跨平台，開源，支援大部分語言，社群好，總之非常不錯，強烈推薦。線上 demo vue admin template 之前使用的是 easy mock ...

API文件工具 Swagger的整合

最近安裝了api文件工具swagger，因為github上已有詳細安裝教程，且安裝過程中沒有碰到大的阻礙，所以此文僅對這次安裝做乙份大致記錄 github安裝詳解 springmvc整合swagger 網上安裝教程 可配合github安裝教程使用 swagger註解詳解 springboot swa...

Swagger的簡介與使用方法

1 是一款讓你更好的書寫api文件的規範且完整框架。2 提供描述 生產 消費和視覺化restful web service。3 是由龐大工具集ruhe合支撐的形式化規範。這個集合涵蓋了從最終使用者介面 底層 庫到商業api管理的方方面面。1.與springboot專案整合 在pom.xml檔案中新增...