整合篇零基礎學習與使用Swagger UI

匯入所需依賴：

>
>
io.springfoxgroupid
>
>
springfox-swagger2artifactid
>
>
2.8.0version
>
dependency
>
>
>
io.springfoxgroupid
>
>
springfox-swagger-uiartifactid
>
>
2.8.0version
>
dependency
>

配置基本資訊：

@configuration
public
class
swaggeruiconfig
//配置專案基本資訊
private apiinfo apiinfo()
}

開啟框架功能：

@enableswagger2

public

class

}編寫測試**：

@restcontroller
//該註解用於描述當前控制器的作用
@api
(tags =
"hello控制器"
)public
class
hellocontroller
/** * 第二種描述方式，使用註解：@apioperation、@apiimplicitparams、@apiimplicitparam
** @param name
* @param age
* @return
*/("/hello2"
)@apioperation
(value =
"輸出使用者資訊"
, notes =
"返回乙個拼接的字串"
)//該註解用於在方法上描述該方法的引數
@apiimplicitparams()
public string hello2
(@requestparam
("name"
) string name,
@requestparam
("age"
) integer age)
("/hello3"
)@apioperation
(value =
"輸出使用者資訊"
, notes =
"返回乙個物件"
)@apiimplicitparams()
public user hello3
(@requestparam
("name"
) string name,
@requestparam
("age"
) integer age)
}

@apimodel
(value =
"user型別"
, description =
"這表示乙個使用者實體"
)public
class
user
public
void
setname
(string name)
public integer getage()
public
void
setage
(integer age)
}

開啟文件頁面： http://localhost:8080/swagger-ui.html

@api：用在請求的類上，表示對類的說明 tags：用於描述當前類的作用 @apioperation：用在請求的方法上，表示對方法的說明 value：用於描述當前方法的作用 notes：用於描述當前方法的備註資訊 @apiparam：用在請求方法的引數上，表示對該引數的說明 name：引數名稱 value：引數說明 required：引數是否必須傳 defaultvalue：引數的預設值 example：引數示例 @apiimplicitparams：用在請求的方法上，表示該方法引數的說明 @apiimplicitparam：用在@apiimplicitparams註解中，表示對該引數的說明 name：引數名稱 value：引數說明 required：引數是否必須傳 paramtype：引數放在哪個地方 · header -- > 請求引數的獲取：@requestheader · query -- > 請求引數的獲取：@requestparam · path -- > 請求引數的獲取：@pathvariable · body（不常用） · form（不常用） datatype：引數的型別，預設string，其它值datatype= "integer" defaultvalue：引數的預設值 example：引數示例 @apiresponses：用在請求的方法上，表示一組響應 @apiresponse：用在@apiresponses註解中，一般用於表達乙個錯誤的響應資訊 code：錯誤碼，例如400 message：錯誤資訊，例如"請求引數未知" response：丟擲異常的類 @apimodel：用於實體類上，表示乙個複雜型別的描述，可用作引數接收、可用作返回物件 value：實體類名稱 description：實體類描述 @apimodelproperty：用在屬性上，描述響應類的屬性 name：引數名稱 value：引數說明 required：引數是否必須傳 datatype：引數的型別，預設string，其它值datatype= "integer" example：引數示例

匯入所需依賴：只匯入這乙個就可以了，之前匯入的那兩個可以全部刪掉了，其他**均保持不變即可

>
>
com.github.xiaoymingroupid
>
>
knife4j-spring-boot-starterartifactid
>
>
3.0.2version
>
dependency
>

開啟文件頁面： http://localhost:8080/doc.html

整合篇零基礎學習與使用Swagger UI

零基礎學習sql篇 1

零基礎學習 nginx tomcat

零基礎深度學習

整合篇 零基礎學習與使用Swagger UI

零基礎學習sql篇 1

零基礎學習 nginx tomcat

零基礎深度學習

相關推薦

整合篇零基礎學習與使用Swagger UI