Setting
General setting
Setting by IDEA
Setting with config file
Setting about postman
Setting rules
api.name
class.doc
class.is.ctrl
class.postman.test
class.postman.prerequest
class.prefix.path
collection.postman.prerequest
collection.postman.test
constant.field.ignore
enum.use.custom
enum.use.by.type
enum.use.ordinal
enum.use.name
field.default.value
field.demo
☆field.doc
field.ignore
field.name
field.requierd
field.order
field.order.with
folder.name
ignore
mdoc.class.filter
mdoc.method.path
mdoc.method.http.method
method.doc
method.content.type
method.default.http.method
method.additional.header
method.additional.param
module
☆method.return
☆method.return.main
☆json.rule.convert
json.rule.enum.convert
json.rule.field.ignore
json.rule.field.name
param.default.value
param.demo
param.doc
param.http.type
param.ignore
param.requierd
path.multi
postman.host
postman.prerequest
postman.test
Supported Callbacks
export.after
yapi.export.before
http.call.after
http.call.before
api.class.parse.before
api.class.parse.after
api.method.parse.before
api.method.parse.after
api.param.parse.before
api.param.parse.after
json.class.parse.before
json.class.parse.after
json.field.parse.before
json.field.parse.after
script tools
☆it
☆tool
regex
logger
helper
httpClient
localStorage
session
config
api
runtime
fieldContext
groovy local extension
EasyApi
document
config
demo
framwork
QA
General configuration
Zero configuration, out of the box
Once the plugin is installed, it can be used without any additional configuration. In general, if any information needs to be provided during the API export, the plugin will prompt a window for you to fill in as required.
Additional configuration options
Setting in IDEA
Convenient and quick, allowing you to adjust default behaviors of the plugin.
Configuration file in project
Highly customizable, enabling adaptation to personalized code style preferences.
Setting by IDEA