Skip to content

Commit fdb07b0

Browse files
TommyLemonTommyLemon
authored
Update 详细的说明文档.md
1 parent 49f3d83 commit fdb07b0

1 file changed

Lines changed: 47 additions & 32 deletions

File tree

‎详细的说明文档.md‎

Lines changed: 47 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# APIJSON 入门教程
22

33
可以先看更清晰直观的视频教程 <br >
4-
https://search.bilibili.com/all?keyword=APIJSON&from_source=webtop_search&spm_id_from=333.851
4+
https://search.bilibili.com/all?keyword=APIJSON
55
![image](https://user-images.githubusercontent.com/5738175/135413311-0207ec13-f7ea-4767-9e34-1a6d08438295.png)
66

77
本文档已部署到官网，浏览和检索体验更好 <br >
@@ -14,12 +14,12 @@ https://github.com/Tencent/APIJSON#%E7%9B%B8%E5%85%B3%E6%8E%A8%E8%8D%90
1414

1515
### A1.关于接口开发
1616

17-
首先是看名字`APIJSON`，API是说这个项目是属于接口开发的项目，JSON是指传输数据格式是JSON格式。介于各位看官的水平高低不齐，这里就先为没有项目经验朋友啰嗦两句接口开发的内容。有经验的朋友可以跳到`A2`继续查看。完整的详细介绍见项目首页 <br >
17+
首先是看名字 `APIJSON`，API 是说这个项目是属于接口开发的项目，JSON 是指传输数据格式是 JSON 格式。介于各位看官的水平高低不齐，这里就先为没有项目经验朋友啰嗦两句接口开发的内容。有经验的朋友可以跳到 `A2` 继续查看。完整的详细介绍见项目首页 <br >
1818
https://github.com/Tencent/APIJSON#--apijson
1919

2020
### A2.功能说明
2121

22-
一个接口的开发，比如Java用SpringBoot，Mybatis来开发一般来说就像下面这个流程
22+
一个接口的开发，比如 Java 用 SpringBoot + Mybatis 来开发一般来说就像下面这个流程
2323

2424
![1545468341131](assets/1545468341131.png)
2525

@@ -29,7 +29,7 @@ https://github.com/Tencent/APIJSON#--apijson
2929

3030
如果使用 [apijson-framework](https://github.com/APIJSON/apijson-framework)，还可进一步简化流程
3131

32-
![1543975563776](assets/1543975563776.png)
32+
![1543975563776](https://raw.githubusercontent.com/Tencent/APIJSON/master/assets/1542345654422.png)
3333

3434

3535
换句话说，使用这个项目作为后端的支持的话，是不需要对每个表写增删改查等接口的，只需在该项目连接的数据里进行表的创建，以及配置接口权限即可。无需进行过多的开发，哪怕是要改结构也仅仅只需要修改表字段而已。想想仅仅是部署一个后端项目，现在需要些的接口就基本写好了，直接调用就行了，是不是挺爽的。
@@ -38,56 +38,68 @@ https://github.com/Tencent/APIJSON#--apijson
3838

3939

4040

41-
## B.安装&使用
42-
>JDK： 1.8+
43-
>
44-
>Maven： 3.0+
45-
>
46-
>数据库：Mysql，Oralce
41+
# B.安装&使用
4742

48-
### B1.下载项目
43+
## B1.环境配置
4944

50-
```bash
45+
JDK: 1.8+
46+
47+
MAVEN: 3.0+
48+
49+
MySQL 5.7+ / PostgreSQL 9.5+ / Oracle 12C+ / ClickHouse 21.1+ / Presto 0.277+ / Hive 3.1.2+ / ...
50+
51+
Intellij IDEA 2018+ / Eclipse Java EE IDE 4.5.1+
52+
53+
## B2.下载项目
54+
55+
```git
5156
git clone https://github.com/APIJSON/APIJSON-Demo.git
5257
```
5358

54-
或者，直接下载ZIP打包好的项目文件。
59+
或者，直接下载 ZIP 打包好的项目文件。
5560

5661
![image](https://user-images.githubusercontent.com/5738175/135412855-574cae7b-402c-4fe0-9959-711e580799af.png)
5762

63+
## B3.导入项目
5864

65+
Eclipse 导入：
5966

60-
### B2.导入项目
67+
顶部菜单 File > Import > Maven > Existing Maven Projects > Next > Browse
6168

62-
Eclipse导入：
69+
选择项目所在目录 [/APIJSON-Demo-Master/APIJSON-Java-Server](https://github.com/APIJSON/APIJSON-Demo/tree/master/APIJSON-Java-Server)/APIJSONBoot
6370

64-
顶部菜单File > Import > Maven > Existing Maven Projects > Next > Browse
65-
66-
[APIJSON-Demo-Master/APIJSON-Java-Server/APIJSONDemo](https://github.com/APIJSON/APIJSON-Demo/tree/master/APIJSON-Java-Server/APIJSONDemo)
71+
当报依赖错误的时候，将同目录下的 libs 里面的 jar 包添加到 Build Path 中。
72+
![1542345887787](assets/1542345887787.png)
6773

68-
报依赖错误的时候，同目录下的`lib`里面的`jar`添加到`Build Path`中。
74+
为了方便修改源代码，你可以像我一样不添加 libs/APIJSON.jar 文件到 Build Path 中。而是将 libs/APIJSON.jar 的源码，复制到当前项目里，然后添加到 Build Path 中。
6975

70-
![1542345887787](assets/1542345887787.png)
76+
源代码在 [APIJSON-Master/APIJSON-Java-Server](https://github.com/Tencent/APIJSON)/APIJSONORM。
7177

72-
为了方便修改源代码，你可以像我一样不添加`libs/apijson-orm.jar`文件到`Build Path`中。而是`libs/apijson-orm.jar`的源码，复制到当前项目里。
78+
## B4.错误修改
7379

74-
源代码在 <br >
75-
https://github.com/Tencent/APIJSON/tree/master/APIJSONORM
80+
有可能 pom.xml 会报错，例如：
7681

77-
### B3. pom.xml的错误修改。
78-
有可能这时候pom.xml中报错，例如：
79-
``` xml
82+
```java
8083
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
8184
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
8285
```
83-
这段代码中的这一句：
84-
``` xml
86+
87+
这段代码中的这一句提示错误：
88+
89+
```java
8590
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
8691
```
87-
提示错误。
88-
其实是maven中安装包的问题。
89-
那么在Window->Preference->Maven->User Settings中查找你的包安装目录删除对应的包。
90-
具体操作请自行百度。
92+
93+
修改步骤：
94+
95+
- 请修改 Eclipse 中的 Maven 镜像地址，以便更快下载或者更新，具体方法自行百度；
96+
- 打开 Eclipse->Windows->Preferences->Maven->Installations->add 这个按钮用于指定 maven 的安装目录。这里不建议使用 eclipse 自带的，需要再自己设置。最终效果如下图所示：
97+
![install3](https://raw.githubusercontent.com/APIJSON/APIJSON-Doc/master/docs/.vuepress/public/assets/install3.png)
98+
- 打开 Eclipse->Windows->Preferences->Maven->User Settings 这是指定 setting.xml 的位置，同时导向自己的本地 maven 仓库。最终效果如下图所示：
99+
![install4](https://raw.githubusercontent.com/APIJSON/APIJSON-Doc/master/docs/.vuepress/public/assets/install4.png)
100+
101+
以上截图仅为示例，实际路径请以自己设定为准。
102+
91103

92104
## C.开发说明
93105

@@ -156,6 +168,9 @@ https://github.com/APIJSON/APIJSON-Demo/blob/master/APIJSON-Java-Server/APIJSOND
156168
3. 点击“测试账号”按钮左边第二个按钮，（也就是“-”左边的第一个）获取各种测试用例；
157169
4. 欢迎大家踊跃共享自己的测试用例；
158170

171+
也可以参考 APIAuto 的文档或视频
172+
https://github.com/TommyLemon/APIAuto
173+
159174
#### C-1-3.测试查询
160175

161176
为了方便测试，我这里使用的Chrome浏览器的Restlet Client插件，大家可以根据自己的喜好使用不同的工具测试。

0 commit comments

Comments
 (0)