Skip to content

Main Navigation Guide Framework Settings Q&A

JetBrains Plugin

Appearance

Sidebar Navigation

Configuration

Overview

IDE Settings

Local Config File

Remote Config File

Config Rules

Available Rules

API Rules

api.name

api.open

api.status

api.tag

Class Rules

class.doc

class.is.ctrl (deprecated)

class.is.spring.ctrl

class.is.feign.ctrl

class.is.jaxrs.ctrl

class.is.quarkus.ctrl

class.is.grpc

class.prefix.path

Field Rules

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 Rules

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 Rules

param.default.value

param.demo

param.doc

param.http.type

param.ignore

param.name

param.required

param.type

param.mock

param.max.depth

Enum Rules

enum.use.custom

JSON Rules

json.rule.convert

json.additional.field

json.unwrapped

json.rule.field.ignore (deprecated)

json.rule.field.name (deprecated)

Postman Rules

postman.host

postman.prerequest

postman.test

postman.class.prerequest

postman.class.test

postman.collection.prerequest

postman.collection.test

postman.format.after

Other Rules

folder.name

module (deprecated)

ignore

constant.field.ignore

endpoint.prefix.path

path.multi

properties.prefix

export.after

yapi.project

yapi.save.before

yapi.save.after

http.call.before

http.call.after

Callbacks & Events

Parse Events

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/Call Events

yapi.export.before

Script Tools

Overview

it

tool

regex

logger

helper

httpClient

httpClient.request

httpClient.response

localStorage

session

config

api

runtime

fieldContext

files

Advanced

Groovy Local Extension

On this page

api.open

Set whether the API is public/open.

Usage

properties

api.open=true

Used to control API visibility in exported documentation.

Edit this page on GitHub

Pager

Previous pageapi.name

Next pageapi.status

Released under the Apache-2.0 License.

Copyright 2019-present tangcent