docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class ApiScraping

    Methods for invoking and validating API Scraper

    Inheritance
    object
    ApiScraping
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Unity.Coding.Editor.ApiScraping
    Assembly: Unity.Coding.Editor.dll
    Syntax
    public static class ApiScraping

    Methods

    Scrape()

    Scrape public API based on .editorconfig rules. Rules in .editorconfig are defined as sections with glob patterns matching .asmdef files in the project.

    Examples enabling API scraping for all assemblies: [*.asmdef] scrape_api = true

    Examples disabling API scraping for assemblies in Test folders: [/Tests/.asmdef] scrape_api = false

    Declaration
    public static void Scrape()

    ValidateAllFilesScraped(List<string>)

    Validate if all .api files match the current state of public API in the codebase. If false, the .api files can be regenerated with ApiScraping.Scrape method or by configuring API Scraper to run automatically.

    Declaration
    public static bool ValidateAllFilesScraped(List<string> failedFileList)
    Parameters
    Type Name Description
    List<string> failedFileList

    List of paths to files that failed validation.

    Returns
    Type Description
    bool
    In This Article
    Back to top
    Copyright © 2026 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)