Skip to content

Commit

Permalink
更新了部分文档和说明
Browse files Browse the repository at this point in the history
  • Loading branch information
jackfrued committed Feb 24, 2020
1 parent 63c17a0 commit fe5ad86
Show file tree
Hide file tree
Showing 11 changed files with 43 additions and 33 deletions.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
2 changes: 1 addition & 1 deletion Day31-35/31-35.玩转Linux操作系统.md
Original file line number Diff line number Diff line change
Expand Up @@ -1283,7 +1283,7 @@ build environment:
### 计划任务
1. 在指定的时间执行命令
1. 在指定的时间执行命令
- **at** - 将任务排队,在指定的时间执行。
- **atq** - 查看待执行的任务队列。
Expand Down
11 changes: 6 additions & 5 deletions Day36-40/36-38.关系型数据库MySQL.md
Original file line number Diff line number Diff line change
Expand Up @@ -936,15 +936,16 @@ drop index idx_student_name on tb_student;
创建视图。
```SQL
create view vw_score
create view vw_avg_score
as
select sid, round(avg(score), 1) as avgscore from tb_record group by sid;
select sid, round(avg(score), 1) as avgscore
from tb_record group by sid;
create view vw_student_score
as
select stuname, avgscore
from tb_student, vw_score
where stuid=sid;
select stuname, avgscore
from tb_student, vw_avg_score
where stuid=sid;
```
> **提示**:因为视图不包含数据,所以每次使用视图时,都必须执行查询以获得数据,如果你使用了连接查询、嵌套查询创建了较为复杂的视图,你可能会发现查询性能下降得很厉害。因此,在使用复杂的视图前,应该进行测试以确保其性能能够满足应用的需求。
Expand Down
8 changes: 7 additions & 1 deletion Day91-100/91.团队项目开发的问题和解决方案.md
Original file line number Diff line number Diff line change
Expand Up @@ -382,6 +382,12 @@ Git不像SVN那样一定需要中央服务器才能工作,上面我们演示
git switch -c <branch-name>
```


```Shell
git checkout -b <branch-name>
```

3. 在自己的分支上开发并在本地做版本控制。

4. 将自己的分支(工作成果)推到服务器。
Expand Down Expand Up @@ -444,7 +450,7 @@ Git不像SVN那样一定需要中央服务器才能工作,上面我们演示
创建`release`分支:

```Shell
git switch -c release-0.1 develop
git checkout -b release-0.1 develop
git push -u origin release-0.1
... ... ...
git pull
Expand Down
7 changes: 2 additions & 5 deletions Day91-100/92.Docker容器详解.md
Original file line number Diff line number Diff line change
Expand Up @@ -361,9 +361,7 @@ systemctl restart sshd
创建需要用于数据卷映射操作的文件夹。

```Shell
mkdir -p /root/gitlab/config
mkdir -p /root/gitlab/logs
mkdir -p /root/gitlab/data
mkdir -p /root/gitlab/{config,logs,data}
```

基于`gitlab/gitlab-ce`镜像创建容器,并暴露80端口(HTTP连接)和22端口(SSH连接)。
Expand Down Expand Up @@ -480,7 +478,6 @@ requirements.txt文件:
flask
flask-restful
flask-cors
redis
gunicorn
```

Expand Down Expand Up @@ -850,7 +847,7 @@ docker push jackfrued/webserver
docker-compose down
```

#### Kubernetes
#### Kubernetes(K8S)

实际的生产环境中常常需要部署和管理多个协同工作的容器,docker compose解决了多容器创建和管理的问题,但是实际项目中,我们还需要Kubernetes(以下都简称为K8S)来提供一个跨主机集群的容器调度平台。K8S可以进行自动化容器的部署、扩展和操作,从而提供以容器为中心的基础架构。该项目是谷歌在2014年启动的项目,建立在谷歌公司十余年运维经验的基础之上,而且谷歌自己的应用也是运行在容器上的。

26 changes: 15 additions & 11 deletions Day91-100/94.网络API接口设计.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,22 @@
## 网络API接口设计

目前许多的Web应用和移动应用都使用了前后端分离的开发模式,前后端分离简单的说就是前端或移动端通过网络API接口和后台进行交互。API是应用程序的编程接口的缩写;网络API通常指的是基于一个URL(统一资源定位符)可以访问到的资源,也就是说通过这个URL我们可以让服务器对某个资源进行操作并返回操作的结果,复杂的业务逻辑被隐藏在简单的API接口中。URL的通用格式如下所示:
目前许多的Web应用和移动应用都使用了前后端分离的开发模式,前后端分离简单的说就是前端或移动端通过网络API接口和后台进行交互,获得接口中提供的数据并负责用户界面的渲染。API是应用程序的编程接口的缩写,网络API通常指的是基于一个URL(统一资源定位符)可以访问到的资源,也就是说通过这个URL我们就可以请求服务器对某个资源进行操作并返回操作的结果。大家可以想想,网络API接口不也是一种封装吗,简单的说就是将复杂的业务逻辑隐藏在简单的API接口中。

URL的通用格式如下所示:

```
协议://用户名:口令@主机:端口/路径1/.../路径N/资源名
```

> 说明:URL中的用户名(有可能不需要提供用户名)、口令(有可能不需要提供口令)、端口(有可能使用默认端口)、路径(资源有可能直接位于根路径`/`下)并不是必需的部分,可以根据需要进行设置。
> **说明**:URL中的用户名(有可能不需要提供用户名)、口令(有可能不需要提供口令)、端口(有可能使用默认端口)、路径(资源有可能直接位于根路径`/`下)并不是必需的部分,可以根据需要进行设置。
网络API通常基于HTTP或HTTPS进行访问,基于HTTP/HTTPS最大的好处就在于访问起来非常的简单方便,而且可以跨语言、跨应用进行访问和互操作。

### 设计原则

#### 关键问题

为移动端或者PC端设计网络API接口一个非常重要的原则是:根据业务实体而不是用户界面或操作来设计。如果API接口的设计是根据用户的操作或者界面上的功能设置来设计,随着需求的变更,用户界面也会进行调整,需要的数据也在发生变化,那么后端开发者就要不停的调整API,或者给一个API设计出多个版本,这些都会使项目的开发和维护成本增加。
为移动端或者PC端设计网络API接口一个非常重要的原则是:**根据业务实体而不是用户界面或操作来设计API接口**。如果API接口的设计是根据用户的操作或者界面上的功能设置来设计,随着需求的变更,用户界面也会进行调整,需要的数据也在发生变化,那么后端开发者就要不停的调整API,或者给一个API设计出多个版本,这些都会使项目的开发和维护成本增加。我们可以将业务实体理解为服务器提供的资源,而URL就是资源的定位符(标识符),这种方式是最为简单自然的。对于相对复杂的用户操作,我们可以提供一个“门面”(设计模式中的“门面模式”),通过该“门面”把多个接口的功能组装起来即可

下面是某个网站开放API的接口,可以看出API的设计是围绕业务实体来进行的,而且都做到了“见名知意”。

Expand All @@ -28,9 +30,9 @@
| comments/destroy | 删除一条评论 |
| comments/reply | 回复一条评论 |

需要说明的是,上面的API接口并不是REST风格的。REST是一种网络应用架构风格,被认为最适合分布式的网络应用。关于REST的知识,可以阅读阮一峰老师的[《理解RESTful架构》](http://www.ruanyifeng.com/blog/2011/09/restful.html)以及[《RESTful API设计指南》](http://www.ruanyifeng.com/blog/2014/05/restful_api.html),当然这两篇文章大家也要批判的阅读,因为上面阐述的观点并不完全正确,有些内容甚至是自相矛盾的。
需要说明的是,**上面的API接口并不是REST风格的**。REST是一种网络应用架构风格,被认为最适合分布式的网络应用。关于REST的知识,可以阅读阮一峰的[《理解RESTful架构》](http://www.ruanyifeng.com/blog/2011/09/restful.html)以及[《RESTful API设计指南》](http://www.ruanyifeng.com/blog/2014/05/restful_api.html),当然这两篇文章大家也要批判的阅读,因为上面阐述的观点并不完全正确,有些内容甚至是自相矛盾的。

API接口返回的数据通常都是**JSON****XML**格式,我们这里不会讲述XML的知识,因为这种格式几乎已经被淘汰掉了。对于JSON格式的数据,我们需要做到不要返回null这的值,因为这样的值一旦处置失当,会给前端和移动端开发带来不必要的麻烦(因为开发者有可能会使用强类型语言)。要解决这个问题可以从源头入手,在设计数据库的时候,尽量给每个字段都加上“not null”约束或者设置合理的默认值约束。
API接口返回的数据通常都是**JSON****XML**格式,XML这种数据格式目前基本已经被弃用了。对于JSON格式的数据,我们需要做到不要返回null这的值,因为这样的值一旦处置失当,会给前端和移动端开发带来不必要的麻烦(因为开发者有可能会使用强类型语言)。要解决这个问题可以从源头入手,在设计数据库的时候,尽量给每个字段都加上“not null”约束或者设置合理的默认值约束。

#### 其他问题

Expand All @@ -42,9 +44,7 @@ API接口返回的数据通常都是**JSON**或**XML**格式,我们这里不

下面以设计评论接口为例,简单说明接口文档应该如何撰写。

#### 评论接口

全局返回状态码
首先,我们可以定义全局返回状态码。

| 返回码 | 返回信息 | 说明 |
| ------ | ------------ | ---------------------------------- |
Expand All @@ -54,7 +54,9 @@ API接口返回的数据通常都是**JSON**或**XML**格式,我们这里不
| 10003 | 评论已被删除 | 查看评论时评论因不和谐因素已被删除 |
| 10004 | …… | …… |

1. **GET** `/articles/{article-id}/comments/`
1. 获取文章评论。

URL:**GET** `/articles/{article-id}/comments/`

开发者:王大锤

Expand Down Expand Up @@ -103,7 +105,9 @@ API接口返回的数据通常都是**JSON**或**XML**格式,我们这里不
}
```

2. **POST** `/articles/{article-id}/comments`
2. 新增文章评论。

**POST** `/articles/{article-id}/comments`

开发者:王大锤

Expand Down Expand Up @@ -140,5 +144,5 @@ API接口返回的数据通常都是**JSON**或**XML**格式,我们这里不



> 提示:如果没有接口文档撰写经验,可以使用在线接口文档编辑平台RAP2或YAPI来进行接口文档撰写,也可以参考我的[《FTX(租房项目)接口文档》](../番外篇/FTX(租房项目)接口文档.md)来了解如何撰写接口文档
> **提示**:如果没有接口文档撰写经验,可以使用在线接口文档编辑平台[RAP2](<http://rap2.taobao.org/>)[YAPI](<http://yapi.demo.qunar.com/>)来进行接口文档撰写
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> 作者:骆昊
>
> 最近有很多想学习Python的小伙伴陆陆续续加入我们的交流群,目前我们的交流群人数已经超过一万人。我们的目标是打造一个优质的Python交流社区,一方面为想学习Python的初学者扫平入门过程中的重重障碍;另一方为新入行的开发者提供问道的途径,帮助他们迅速成长为优秀的职业人;此外,有经验的开发者可以利用这个平台把自己的工作经验无偿分享或有偿提供出来,让大家都能够得到职业技能以及综合素质的全面提升。之前的公开课和线下技术交流活动因为工作的关系荒废了一段时间了,但是各位小伙伴仍然活跃在交流群并一如既往的支持我们,在此向大家表示感谢。近期开始持续更新前15天和最后10天的内容,前15天是写给初学者的,我希望把上手的难度进一步降低,例子程序更加简单清晰;最后10天是Python项目实战和面试相关的东西,我希望内容更详实和完整,尤其是第100天的面试题部分;创作不易,感谢大家的打赏支持,这些钱不会用于购买咖啡而是通过腾讯公益平台捐赠给需要帮助的人([点击](./更新日志.md)了解捐赠情况)。
> 最近有很多想学习Python的小伙伴陆陆续续加入我们的交流群,目前我们的交流群人数已经超过一万人。我们的目标是打造一个优质的Python交流社区,一方面为Python初学者扫平入门过程中的重重障碍,另一方为新入行的开发者提供问道的门径,帮助他们迅速成长。我自己很希望更多有经验的开发者加入到这个平台,把自己的工作经验无偿分享或有偿提供出来,让大家最终都能够通过这个平台获取对自己有帮助的信息。我的知乎号是[Python-Jack](https://www.zhihu.com/people/jackfrued),之前是我的团队在协助运营,从现在开始我会自己管理这个知乎号,持续为大家提供高质量的文章和新的学习内容,也欢迎大家关注我在知乎的文章和问题回答。创作不易,感谢大家的打赏支持,这些钱不会用于购买咖啡而是通过腾讯公益平台捐赠给需要帮助的人([点击](./更新日志.md)了解捐赠情况)。
![](./res/python-qq-group.png)

Expand Down Expand Up @@ -43,11 +43,11 @@

给初学者的几个建议:

- Make English as your working language.
- Practice makes perfect.
- All experience comes from mistakes.
- Don't be one of the leeches.
- Either stand out or kicked out.
- Make English as your working language. (让英语成为你的工作语言)
- Practice makes perfect. (熟能生巧)
- All experience comes from mistakes. (所有的经验都源于你犯过的错误)
- Don't be one of the leeches. (不要当伸手党)
- Either outstanding or out. (要么出众,要么出局)

### Day01~15 - [Python语言基础](./Day01-15)

Expand Down Expand Up @@ -422,7 +422,9 @@
- 爬取房地产行业数据
- 爬取二手车交易平台数据

### Day76~90 - [数据处理和机器学习](./Day76-90)
### Day76~90 - [数据分析和机器学习](./Day76-90)

> **温馨提示**:数据分析和机器学习的内容在code文件夹中,是用jupyter notebook书写的代码和笔记,需要先启动jupyter notebook再打开对应的文件进行学习。2020年会持续补充相关文档,希望大家持续关注。
#### Day76 - [机器学习基础](./Day76-90/76.机器学习基础.md)

Expand Down Expand Up @@ -452,7 +454,7 @@

#### Day89 - [Tensorflow实战](./Day76-90/89.Tensorflow实战.md)

#### Day90 - [推荐系统](./Day76-90/90.推荐系统.md)
#### Day90 - [推荐系统实战](./Day76-90/90.推荐系统实战.md)

### Day91~100 - [团队项目开发](./Day91-100)

Expand Down Expand Up @@ -497,7 +499,7 @@

- 团队的构成和角色

> 说明:谢谢付祥英女士绘制了下面这张精美的公司组织架构图
> 说明:谢谢**付祥英**女士帮助我绘制了下面这张精美的公司组织架构图
![company_architecture](./res/company_architecture.png)

Expand Down Expand Up @@ -578,7 +580,7 @@
3. 使用Docker创建容器(Nginx、MySQL、Redis、Gitlab、Jenkins)
4. 构建Docker镜像(Dockerfile的编写和相关指令)
5. 容器编排(Docker-compose)
6. 集群管理
6. 集群管理(Kubernetes)

#### 第93天:[MySQL性能优化](./Day91-100/93.MySQL性能优化.md)

Expand Down

0 comments on commit fe5ad86

Please sign in to comment.