-
methodId
String methodId
methodId handled by md5
- 从以下版本开始:
- 1.7.3 +
-
name
String name
method name
- 从以下版本开始:
- 1.7.3 +
-
order
int order
method order
- 从以下版本开始:
- 1.7+
-
desc
String desc
method description
-
detail
String detail
detailed introduction of the method
-
serverUrl
String serverUrl
server url
-
url
String url
controller method url contains server
-
path
String path
controller path
-
type
String type
http request type
-
author
String author
http request author
-
headers
String headers
only used for generate markdown and adoc
http readers
-
contentType
String contentType
http contentType
-
requestHeaders
List<E> requestHeaders
http request headers
-
pathParams
List<E> pathParams
path params
-
queryParams
List<E> queryParams
query params
-
requestParams
List<E> requestParams
http request params
-
requestUsage
String requestUsage
http request-example usage(requestUrlParam + requestBody)
-
requestExample
ApiRequestExample requestExample
request example detail
-
responseUsage
String responseUsage
http response usage
-
responseParams
List<E> responseParams
http response params
-
deprecated
boolean deprecated
method deprecated