Swagger API管理,漢化

2021-08-29 12:35:35 字數 3455 閱讀 2122

用於類;表示標識這個類是swagger的資源

tags–表示說明

value–也是說明,可以使用tags替代

但是tags如果有多個值,會生成多個list

@controller

@api(value="使用者controller",tags=)

public class webcontroller

@apioperation(value = "獲取資訊",notes = "獲取資訊1",httpmethod = "get")

@apioperation() 用於方法;表示乙個http請求的操作

value用於方法描述

notes用於提示內容

tags可以重新分組(視情況而用)

@apiparam() 用於方法,引數,字段說明;表示對引數的新增元資料(說明或是否必填等)

name–引數名

value–引數說明

required–是否必填

@api(value="使用者controller",tags=)

@restcontroller

public class usercontroller ,notes="注意問題點")

public user getuserinfo(@apiparam(name="id",value="使用者id",required=true) long id,@apiparam(name="username",value="使用者名稱") string username)

@apimodel()用於類 ;表示對類進行說明,用於引數用實體類接收

value–表示物件名

description–描述

都可省略

@apimodelproperty()用於方法,字段; 表示對model屬性的說明或者資料操作更改

value–字段說明

name–重寫屬性名字

datatype–重寫屬性型別

required–是否必填

example–舉例說明

hidden–隱藏

@apimodel(value="user物件",description="使用者物件user")

public class user implements serializable

@apioperation("更改使用者資訊")

public int updateuserinfo(@requestbody @apiparam(name="使用者物件",value="傳入json格式",required=true) user user)

@apiignore()用於類或者方法上,可以不被swagger顯示在頁面上

比較簡單, 這裡不做舉例

@apiimplicitparam() 用於方法

表示單獨的請求引數

@apiimplicitparams() 用於方法,包含多個 @apiimplicitparam

name–引數ming

value–引數說明

datatype–資料型別

paramtype–引數型別

example–舉例說明

@apioperation("查詢測試")

//@apiimplicitparam(name="name",value="使用者名稱",datatype="string", paramtype = "query")

注意ui.html是在resources目錄下

'use strict';

/* jshint quotmark: double */

window.swaggertranslator.learn();

src="webjars/springfox-swagger-ui/images/logo_small.png" alt="springboot整合swagger2(附漢化教程)"//>swagger

SwaggerAPI註解詳解

註解 api 作用在類上,用來標註該類具體實現內容。表示標識這個類是swagger的資源 引數 tags 可以使用tags 允許您為操作設定多個標籤的屬性,而不是使用該屬性。description 可描述描述該類作用。apiimplicitparam 作用在方法上,表示單獨的請求引數 引數 name...

swaggerAPI介面文件分組

swagger是乙個深度整合的後台api文件工具,極大的方便了後端的開發測試以及和前端的對接工作。但是當專案中的介面越來越多時,會導致頁面上的介面過多,檢視起來不是很方便,這時可以使用swagger的分組功能將介面進行分組分頁展示。分組的規則可以基於路徑和註解等,下面主要介紹下基於註解的分類,這種方...

SwaggerAPI註解詳解,以及註解常用引數配置

作用在類上,用來標註該類具體實現內容。表示標識這個類是swagger的資源 引數 1.tags 可以使用tags 允許您為操作設定多個標籤的屬性,而不是使用該屬性。2.description 可描述描述該類作用。作用在方法上,表示單獨的請求引數 引數 1.name 引數名。2.value 引數的具體...