Swagger與SpringMVC專案整合

為了方便的管理專案中api介面，在網上找了好多關於api介面管理的資料，感覺目前最流行的莫過於swagger了，功能強大，ui介面漂亮，並且支援**測試等等，所以本人仔細研究了下swagger的使用，下面就如何將swagger與個人的springmvc專案進行整合做詳細說明：

最終api管理介面：

詳細步驟：

utf-8

3.2.9.release

2.4.4

....

com.mangofactory

swagger-springmvc

0.9.5

com.fasterxml.jackson.core

jackson-annotations

$com.fasterxml.jackson.core

jackson-databind

$com.fasterxml.jackson.core

jackson-core

$package com.spg.apidoc.common.configer;

import org.springframework.beans.factory.annotation.autowired;

import org.springframework.context.annotation.bean;

import org.springframework.context.annotation.configuration;

import com.mangofactory.swagger.configuration.springswaggerconfig;

import com.mangofactory.swagger.models.dto.apiinfo;

import com.mangofactory.swagger.plugin.enableswagger;

import com.mangofactory.swagger.plugin.swaggerspringmvcplugin;

/** * 專案名稱：apidoc

* * @description:

* @author wind-spg

* @create_time：2023年2月10日 上午10:27:51

* @version v1.0.0

* */

@configuration

@enableswagger

// loads the spring beans required by the framework

public class myswaggerconfig

/*** every swaggerspringmvcplugin bean is picked up by the swagger-mvc

* framework - allowing for multiple swagger groups i.e. same code base

* multiple swagger resource listings.

*/@bean

public swaggerspringmvcplugin customimplementation()

private apiinfo apiinfo()

}@responsebody

@requestmapping(

value = adduser, method = requestmethod.post, produces = application/json; charset=utf-8)

@apioperation(value = 新增使用者, httpmethod = post, response = baseresultvo.class, notes = add user)

public string adduser(@apiparam(required = true, name = postdata, value = 使用者資訊json資料) @requestparam(

}說明：

其中@apioperation和@apiparam為新增的api相關註解，個引數說明如下：

@apioperation(value = 「介面說明」, httpmethod = 「介面請求方式」, response = 「介面返回引數型別」, notes = 「介面發布說明」；其他引數可參考原始碼；

@apiparam(required = 「是否必須引數」, name = 「引數名稱」, value = 「引數具體描述」

在github上**swaggerui專案，將dist下所有內容拷貝到本地專案webapp下面，結果目錄如下圖所示：

將index.html中修改為http://localhost:8080//api-docs

到此為止，所有配置完成，啟動你的專案，訪問http://localhost:8080即可看到如下所示頁面：

Swagger與SpringMVC專案整合

utf 8project.build.sourceencoding 3.2.9.releaseversion.spring 2.4.4version.jackson properties com.mangofactorygroupid swagger springmvcartifactid 0.9....

SpringBoot與Swagger的整合

swagger是乙個完整的框架，用於自動生成介面文件，可極大減少後台開發人員的介面文件編輯所消耗的時間，並保證介面文件風格的一致性。在專案的pom.xml檔案中插入如下 版本號自行選擇。io.springfoxgroupid springfox swagger2artifactid 2.6.1ver...

Swagger的介紹與使用

swagger是乙個規範和完整的框架，用於生成 描述 呼叫和視覺化restful風格的web服務。作用 功能測試。io.springfoxgroupid springfox swagger2artifactid 2.6.1version dependency io.springfoxgroupid ...