How to group APIs to folder

There are two distinct concepts to keep in mind:

• folder.name — the folder/group name shown in the exported tree (Postman folder, YApi cat menu, Markdown section, …). Use this to organize APIs into folders.
• yapi.project — the YApi project token that determines which YApi project the APIs are exported to. It is selected by the @project doc tag; it does not set the folder.

Using the folder.name rule

Configure the folder.name rule to override the folder/group name:

# Use the class simple name as the folder name
folder.name=groovy:it.name()

# Or read a custom @folder doc tag from the class
folder.name=groovy:it.containingClass().doc("folder") ?: it.containingClass().name()

The rule is evaluated against the API method (it is the method); it.containingClass() returns the controller class.

Using the @project tag (YApi project only)

The @project tag resolves to the yapi.project rule and selects which YApi project the API belongs to — it is not for grouping APIs into folders:

/**
 * User Management API
 *
 * @project user-management
 */
@RestController
@RequestMapping("/api/users")
public class UserController {
    // ...
}

# Default built-in rule (already provided by the yapi.project extension):
yapi.project=#project

See yapi.project for details.

Using the api.tag rule

api.tag adds tags/categories to an endpoint. Tags are merged across all matching rules (MERGE_DISTINCT):

# Read a @tag doc tag from the method
api.tag=groovy:it.doc("tag")

Tags are useful for filtering or labeling in Postman/YApi but do not control the folder tree.