https://github.com/sunzxyong/apiinspect

An api compatibility inspect gradle plugin.（一个Api兼容性检测的Gradle插件）
https://github.com/sunzxyong/apiinspect

api api-compat check compat gradle-plugin groovy inspect

Last synced: 3 months ago
JSON representation

An api compatibility inspect gradle plugin.（一个Api兼容性检测的Gradle插件）

• Host: GitHub
• URL: https://github.com/sunzxyong/apiinspect
• Owner: Sunzxyong
• License: apache-2.0
• Created: 2018-12-25T11:41:40.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-01-09T07:47:26.000Z (almost 6 years ago)
• Last Synced: 2024-09-27T15:05:22.372Z (3 months ago)
• Topics: api, api-compat, check, compat, gradle-plugin, groovy, inspect
• Language: Groovy
• Homepage:
• Size: 178 KB
• Stars: 90
• Watchers: 6
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# **ApiInspect**

An api compatibility inspect gradle plugin.（一个Api兼容性检测的Gradle插件）

----

[ ![Download](https://api.bintray.com/packages/sunzxyong/maven/ApiInspect/images/download.svg) ](https://bintray.com/sunzxyong/maven/ApiInspect/_latestVersion)[![Travis](https://img.shields.io/travis/rust-lang/rust.svg)]() [![Hex.pm](https://img.shields.io/hexpm/l/plug.svg)]() ![](https://img.shields.io/badge/architecture-clean-yellow.svg)

## **Introduce**

## **Usage**

### **Installation**

Add dependencies in **`build.gradle`** of the **`root project`**：

```

    dependencies {

        // ...

        classpath('com.zxy.android.plugin:api-inspect:1.2.0') {

            exclude group: 'com.android.tools.build', module: 'gradle'

        }

    }

```

and add the **`apply plugin`** to build.gradle in the module：

```

apply plugin: 'api.inspect'

```

### **Configuration**

By default, **`ApiInspect`** will inspects all apis but does not contain the system api. Of course, you can also customize **`exclude`** or **`include`** Settings：

```

apiInspect {

    enable true //Whether api inspect is enabled.

    inspectSystemApi false //Whether to inspect the system api.

    //Specify the library to inspect.

//    include {

//        //Value is the package name.

//        api "com.zxy.tiny"

//    }

    //Specify the library not to inspect.

//    exclude {

//        //Value is the package name.

//        api 'com.zxy.tiny'

//        api 'com.google.zxing'

//    }

}

```

## **Inspect Result**

When the Apk build is completed. The results of the inspection will be printed on the console：



Of course, The results of the inspection will also be stored in the **`api-inspect`** directory：



## **Support**

> **Support Gradle Plugin Version： >=2.3.3**

## **Version**

Version control supports the semantic 2.0 protocol

* **1.0.0：First version, support api compatibility inspect.**

* **1.1.0：Optimization logic.**

* **1.2.0：Optimization of the library plugin.**

## **About**

* **Blog**：[https://zhengxiaoyong.com](https://zhengxiaoyong.com)

* **Wechat**：

![](https://raw.githubusercontent.com/Sunzxyong/ImageRepository/master/qrcode.jpg)

## **License**

>

>     Apache License

>

>     Version 2.0, January 2004

>     http://www.apache.org/licenses/

>

>     Copyright 2018 郑晓勇

>

>  Licensed under the Apache License, Version 2.0 (the "License");

>  you may not use this file except in compliance with the License.

>  You may obtain a copy of the License at

>

>      http://www.apache.org/licenses/LICENSE-2.0

>

>  Unless required by applicable law or agreed to in writing, software

>  distributed under the License is distributed on an "AS IS" BASIS,

>  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

>  See the License for the specific language governing permissions and

>  limitations under the License.