DOCUMENT-API.md
# All Api Documents
## 1.Read Me
### 1.1. Rules for Reading
There are some categories of each document for flag:
* 「Tp」Third-part extensions ( May be extend from Open Source Project ).
* 「Kt」Tools in zero framework such as `Ux, Ut, Fn`.
* 「Co」Core classes in zero framework, it does not contain `web container` docs.
* 「Web」Critical `web` docs include **engine** and **container** docs.
* 「Ex」Zero Extension documents.
* 「Ix」Zero Infix documents.
## 2.Document List
### 2.1. Core
| Parent Module | Module | Links |
|---:|---:|---:|
| vertx-gaia | vertx-co | [Core Library](vertx-gaia/vertx-co/src/document/index.html) |
| | vertx-tp | [Third Part Integration](vertx-gaia/vertx-tp/src/document/index.html) |
| | vertx-up | [Web Container](vertx-gaia/vertx-up/src/document/index.html) |
| | vertx-rx | [Reactive Style](vertx-gaia/vertx-rx/src/document/index.html) |
| | vertx-micro | [Micro Service](vertx-gaia/vertx-micro/src/document/index.html) |
### 2.2. Infix
> Different plugins for Tech.
| Parent Module | Module | Links |
|---:|---:|---:|
| vertx-ifx | zero-ifx-es | [Elastic Search](vertx-ifx/zero-ifx-es/src/document/index.html) |
| | zero-ifx-excel | [Excel Plugin](vertx-ifx/zero-ifx-excel/src/document/index.html) |
| | zero-ifx-feign | [Feign Plugin](vertx-ifx/zero-ifx-feign/src/document/index.html) |
| | zero-ifx-history | [Trash Service Archive](vertx-ifx/zero-ifx-history/src/document/index.html) |
| | zero-ifx-iqiy | [AiQiyi Plugin](vertx-ifx/zero-ifx-iqiy/src/document/index.html) |
| | zero-ifx-mongo | [Mongo Database](vertx-ifx/zero-ifx-mongo/src/document/index.html) |
| | zero-ifx-native | [Vert.x Native Clients](vertx-ifx/zero-ifx-native/src/document/index.html) |
| | zero-ifx-neo4j | [Neo4j Database](vertx-ifx/zero-ifx-neo4j/src/document/index.html) |
| | zero-ifx-qiniu | [QiNiu Cloud Storage](vertx-ifx/zero-ifx-qiniu/src/document/index.html) |
| | zero-ifx-redis | [Redis Plugin](vertx-ifx/zero-ifx-redis/src/document/index.html) |
| | zero-ifx-sms | [Ali Mobile Sms Service](vertx-ifx/zero-ifx-sms/src/document/index.html) |
### 2.3. Extension
| Parent Module | Module | Links |
|---:|---:|---:|
| vertx-pin | zero-ambient | [Ambient Environment](vertx-pin/zero-ambient/src/document/index.html) |
| | zero-atom | [Atom Dynamic Modeling](vertx-pin/zero-atom/src/document/index.html) |
| | zero-crud | [Crud Module](vertx-pin/zero-crud/src/document/index.html) |
| | zero-erp | [Organization Resources](vertx-pin/zero-erp/src/document/index.html) |
| | zero-graphic | [Graphic Engine](vertx-pin/zero-graphic/src/document/index.html) |
| | zero-jet | [Dynamic Routing](vertx-pin/zero-jet/src/document/index.html) |
| | zero-ke | [Extension Core](vertx-pin/zero-ke/src/document/index.html) |
| | zero-lbs | [Location Based Service](vertx-pin/zero-lbs/src/document/index.html) |
| | zero-quiz | [Quiz Testing Framework](vertx-pin/zero-quiz/src/document/index.html) |
| | zero-rbac | [Rbac Module](vertx-pin/zero-rbac/src/document/index.html) |
| | zero-router | [Micro Api Gateway](vertx-pin/zero-router/src/document/index.html) |
| | zero-ui | [(UI) User Interface](vertx-pin/zero-ui/src/document/index.html) |
## 3. Summary