swagger注釋API詳細說明

2021-08-19 08:30:40 字數 985 閱讀 4746

注釋彙總

作用範圍

api使用位置

物件屬性

@apimodelproperty

用在出入引數物件的字段上

協議集描述

@api

用於controller類上

協議描述

@apioperation

用在controller的方法上

response集

@apiresponses

用在controller的方法上

response

@apiresponse

用在 @apiresponses裡邊

非物件引數集

@apiimplicitparams

用在controller的方法上

非物件引數描述

@apiimplicitparam

用在@apiimplicitparams的方法裡邊

描述返回物件的意義

@apimodel

用在返回物件類上

@apioperation("資訊軟刪除")

@apiresponses()

@apiimplicitparams()

public restfulprotocol remove(long id) )

@requestbody

messageparam param

提交的引數是這個物件的乙個json,然後會自動解析到對應的字段上去,也可以通過流的形式接收當前的請求資料,但是這個和上面的接收方式僅能使用乙個(用@requestbody之後流就會關閉了)

header
@apiimplicitparams() 

string idstr = request.getheader("id");

if (stringutils.isnumeric(idstr))

form
@apiimplicitparams()

swagger注釋API詳細說明

注釋彙總 作用範圍 api使用位置 物件屬性 apimodelproperty 用在出入引數物件的字段上 協議集描述 api 用於controller類上 協議描述 apioperation 用在controller的方法上 response集 apiresponses 用在controller的方...

swagger注釋API詳細說明

注釋彙總 作用範圍 api使用位置 物件屬性 apimodelproperty 用在出入引數物件的字段上 協議集描述 api 用於controller類上 協議描述 apioperation 用在controller的方法上 response集 apiresponses 用在controller的方...

swagger注釋API詳細說明

注釋彙總 作用範圍 api使用位置 物件屬性 apimodelproperty 用在出入引數物件的字段上 協議集描述 api 用於controller類上 協議描述 apioperation 用在controller的方法上 response集 apiresponses 用在controller的方...