Python-接口开发入门解析
一、开发接口的作用
1、mock接口:模拟一些接口。有一些有关联的接口,在别的接口没有开发好的时候,需要用这个接口,就可以写一个假接口,返回想要的结果来模拟这个接口。
2、知道服务端的开发逻辑,有助于测试;
3、比如不想让其他人看很多数据库中的数据,可以通过接口只返回一部分数据。
二、开发一个接口
1、flask是一个轻量级的开发框架
__name__:代表当前这个python文件
server = flask.Flask(__name__) :把当前这个python文件,当做一个服务
2、一个无需传参数的get接口
其中,‘index'是接口的路径。
method如果不写,默认为get。如果需要支持多种,可以写成['get','post']
port是端口号,默认为5000。debug=True,这样改了代码之后,不需要重启服务,会自动重启。
先运行,然后用postman调用该接口,如下
可以看到,中文的编码之后的,想显示中文,按照下图方法即可
3、一个post接口
开发一个注册接口,请求参数为:username和passwd。如果数据库中有该用户,就返回用户已存在。如果该用户不存在,就在数据库插入一条数据,返回注册成功。
下面的代码需要连接数据库,连接数据库部分省略了。
为了让其他人也可以访问这个接口,可以用如下方法:
host=0.0.0.0表示只要在同一个局域网,别人访问的时候,用你的ip就可以访问了。ip指的是电脑的ip。
假如电脑的ip是10.2.88.122,那么别人电脑访问10.2.88.122:8999/reg即可。
三、开发接口目录
目录结构如下
主目录命名为了my_api,可以根据实际情况命名
bin:可执行文件,即启动程序
config:配置文件
data:放置一些数据,如sql、入参等
lib:主逻辑
logs:log
readme:一些说明
我们把上面的代码分到各个目录里面
1、配置文件config-setting.py
存放一些常量,如数据库的信息,redis的信息,端口号等
2、lib目录下tools.py
tools文件里写了怎么操作sql和redis
倒入setting里的信息,需要把my_api加到环境变量里。
在my_api文件夹上右击,选择mark directory as ->Source Root
导入setting
如果常量太多,则可以直接from config import setting
使用时,setting.MYSQL_INFO。用setting加点的方法。
3、lib目录下interface.py
这里写接口的主逻辑
4、bin目录下start.py
先从interface中导入server,从setting中导入端口号。
启动程序时,只需运行start.py即可
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持【听图阁-专注于Python设计】。