# grpc-java-api-checker

**Repository Path**: mirrors_grpc/grpc-java-api-checker

## Basic Information

- **Project Name**: grpc-java-api-checker
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2025-10-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# grpc-java-api-checker

[![GitHub Actions Testing](https://github.com/grpc/grpc-java-api-checker/actions/workflows/testing.yml/badge.svg?branch=master)](https://github.com/grpc/grpc-java-api-checker/actions/workflows/testing.yml?branch=master)

An Error Prone plugin that checks for usages of grpc-java APIs that are annotated with `@ExperimentalApi` or `@Internal`.

**NOTE: grpc-java-api-checker works with grpc-java version 1.10.0 or greater.**

The error examples:

```
src/main/java/com/example/App.java:10: error: [GrpcInternal] @Internal should not be used in application code
    System.out.println(InternalStatus.MESSAGE_KEY);
                       ^
    (see https://github.com/grpc/grpc-java)

src/main/java/com/example/App.java:11: error: [GrpcExperimentalApi] @ExperimentalApi should not be used in application code
    System.out.println(Grpc.TRANSPORT_ATTR_REMOTE_ADDR);
                           ^
    (see "https://github.com/grpc/grpc-java/issues/1710")
```

## Usage

Using the grpc-java-api-checker requires configuring your project to build with the Error Prone Java compiler.
You can see the Error Prone documents [here](http://errorprone.info/).

### Examples

#### Maven
The example is [here](examples/pom.xml)

``` sh
cd examples/
mvn compile
```

#### Gradle
The example is [here](examples/build.gradle)

``` sh
cd examples/
./gradlew compileJava
```

#### Bazel
The example is [here](examples/BUILD.bazel)

``` sh
cd examples/
bazel build //...
```

## Build and Test

``` sh
# Compile
mvn compile

# Test
mvn test

# Build
mvn build

# Publish to Local
mvn install
```