Knife4j新增lombok及註解初探

在pom檔案裡新增包

1

2<
dependency
>
3<
groupid
>org.projectlombok
groupid
>
4<
artifactid
>lombok
artifactid
>
5<
optional
>true
optional
>
6dependency
>

使用例項:

註解載入類頭上,然後再括號內新增引數及引數描述的值         

1 @apimodel(value = "商品類", description = "用於儲存商品物件的字段")

一般最常用的引數就是value和description兩個引數,會顯示在實體物件文件的對應位置,適合前段查閱,其他引數新增了,並未在介面顯示出來

其中,value在knife4j和swagger-ui.中均有顯示,description在swagger-ui.中有顯示,在knife4j並未顯示

discriminatory和reference兩個string型別的引數,向其中任意新增內容未發現在介面描述中顯示內容

subtypes要新增乙個類.class,用於指向當前類的子類是誰,後端自己看的,前段看不到 parent 要新增乙個類.class,用於指向當前類的父類是誰,後端自己看的,前段看不到

綜上所述,在knife4j中,如果僅僅是需要返回api文件,@apimodel僅需設定乙個引數value即可.

1 @apimodel(value = "商品類")

@apimodelproperty : 字段描述註解

屬性名稱

資料型別

預設值說明

value

string

" "字段說明

name

string

" "重寫屬性名字

datatype

string

" "重寫屬性型別

required

string

" "是否必填 

example

string

" "舉例說明

hidden

string

" "隱藏

使用例項:

註解載入在字段上

常用模型:

1 @apimodelproperty(required = true,notes = "時間戳",example = "1567425139000") 

2private
long time;

swagger增強框架Knife4j

swagger增強knife4j 我稱之為swagger plus 哈哈哈,使用起來特別簡單,在有swagger的基礎上,com.github.xiaoymin groupid knife4j spring boot starter artifactid 2.0.4 version dependen...

使用Knife4j美化Swagger

使用knife4j美化swagger org.springframework.bootgroupid spring boot starter webartifactid dependency io.springfoxgroupid springfox swagger uiartifactid 2.7...

介面自動生成工具 knife4j

com.github.xiaoymingroupid knife4j spring boot starterartifactid dependency 2 在模組中新增乙個關於knife4j的配置類 package com.cast.common.knife4j import com.github....