Skip to content

Main Navigation 指南框架支持配置 QA

简体中文

简体中文

主题

Sidebar Navigation

配置

概览

规则编写

在 IDEA 中设置

使用项目内配置文件

使用远程配置文件

YApi 相关配置

Postman 相关配置

YApi Mock 配置

可用配置规则

规则总览

API 规则

api.name

api.open

api.status

api.tag

Class 规则

class.doc

class.is.ctrl (已废弃)

class.is.spring.ctrl

class.is.feign.ctrl

class.is.jaxrs.ctrl

class.is.quarkus.ctrl

class.is.grpc

class.prefix.path

Field 规则

field.default.value

field.demo

field.doc

field.ignore

field.mock

field.name

field.name.prefix

field.name.suffix

field.required

field.order

field.order.with

field.advanced

field.max.depth

Method 规则

method.doc

method.return

method.return.main

method.content.type

method.default.http.method

method.additional.header

method.additional.param

method.additional.response.header

Param 规则

param.default.value

param.demo

param.doc

param.http.type

param.ignore

param.name

param.required

param.type

param.mock

param.max.depth

Enum 规则

enum.use.custom

JSON 规则

json.rule.convert

json.additional.field

json.unwrapped

json.rule.field.ignore (已废弃)

json.rule.field.name (已废弃)

Postman 规则

postman.host

postman.prerequest

postman.test

postman.class.prerequest

postman.class.test

postman.collection.prerequest

postman.collection.test

postman.format.after

其他规则

folder.name

module (已废弃)

yapi.project

ignore

constant.field.ignore

endpoint.prefix.path

path.multi

回调与事件

解析事件

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

json.method.parse.before

json.method.parse.after

导出/调用事件

export.after

yapi.export.before

yapi.save.before

yapi.save.after

http.call.before

http.call.after

脚本工具

概览

it

tool

regex

logger

helper

httpClient

httpClient.request

httpClient.response

localStorage

session

config

api

runtime

fieldContext

files

页面导航

field.doc

设置字段的文档说明。

用法

properties

field.doc=groovy:it.comment()

这是最常用的规则之一，用于决定如何提取字段描述。

在 GitHub 上编辑此页

最后更新于:

Pager

上一页field.demo

下一页field.ignore

基于 Apache-2.0 许可发布

Copyright 2019-present tangcent