初始化

TIP

api-shop 核心类，实例化后生成接口对象，你只需要访问实例的方法，就可以调用相应的业务代码。

ap = ApiShop(conf,options)

ApiShop 接口配置(conf)

键	类型	说明	例子
url	str/list	接口访问的 url，支持 list 包裹多个 url，也支持<参数名>模式，url 中添加<参数名>的话，方法参数列表中必须要包含该参数，并指定required=True	login,user/<id>
class	str/Class 对象	为字符串时，是Api接口继承对象的路径，为对象时就是该Api接口继承对象	account.views.api_login
methods	dict	这个对象包含了每个接口可以接受的方法和参数	key 可以为 GET/POST/PUT/PATCH/PUT/DELETE 等 http 支持的方法

methods 配置说明

在配置参数中或者@add_api 类装饰器添加

单个 methods 的 value 为一个 list 对象，其中描述了该方法支持的参数

键	类型	说明	例子
name	str	参数名字	username
type	object	参数类型，目前支持 int，float，list，dict，set，tuple，bool，也支持自定义类型和其他可以被转换的类型	详情可以查看 data_format 扩展
required	bool	是否必要参数，如果为 True，用户请求中没有该参数将会被拦截	缺省为False
min	int	参数的最小值(int)或者最小长度(str/list/set/tuple)，用户提交小于或者短于这个值的参数，将会被拦截	5
max	int	参数的最大值(int)或者最大长度(str/list/set/tuple)，用户提交大于或者超过长度的参数，将会被拦截	5
default	同类型参数、方法、类	比如 type=int 的一个参数，default=1 的时候，用户如果不提交参数，将会自动填充 1，如果 default 为一个方法或者类，将会自动填充运行/实例化结果
options	list	这是参数的可选项，用户提交的参数必须在可选项中，否则将会被拦截	options=['a','c'] 表示用户只能提交该参数的值为 a 或者 c
description	str	参数的描述，用来给前端开发人员的参考说明

ApiShop 设置参数(options)

参数名称	类型	默认值	说明
base_url	str	/api/	基础 url，用以组合给前端的 api url
bad_request	bool	True	参数 bad_request 如果是真，发生错误返回一个坏请求给前端，否则都返回 200 的 response，里面附带 status=error 和 msg 附带错误信息
bad_request_error_status	str	'error'	默认的 bad_request 状态信息，bad_request=False 生效
document	str	document.html	文档模板绝对路径
lang	str	en	ApiShop 的语言，默认为 en 英文，可选项为 zh 中文
debug	bool	True	是否开启调试信息
auto_create_folder	bool	False	自动创建文件夹（实验方法）
auto_create_file	bool	False	自动创建文件（实验方法）
auto_create_class	bool	False	自动创建类（实验方法）
auto_create_method	bool	False	自动创建方法（实验方法）

业务代码入口

实例方法 api_entry

实例化 ApiShop 类之后，需要在 web 框架的路由中添加一个正则路由，好让 api 开头的路由，全部被 ApiShop 接管。

ap = ApiShop(conf,options)

app_name='api'

urlpatterns = [
    path('api_data', ap.get_api_data, name='api_data'), # api文档需要的接口
    path('document/', ap.render_documents, name='document'), #api文档渲染的路由
    re_path(r'([\s\S]*)', ap.api_entry, name='index') # 接管api/下面其他的全部路由到api_entry入口方法
]

调用其他接口

实例方法 api_run

从 1.12.0 版本开始，ApiShop 核心类提供了一个 api_run 的方法，用来在代码中运行另外一个 api 代码，方便复用。 这个方法将取代原本的 get_api_result_json 和 get_api_result_response

'''
    request   直接传入当前request，
    url       就是你想要访问的接口url
    method    如果不传入，就是 = request.method
    parameter 请求参数，如果不传入，就没有参数传入到api中
    json      默认True返回json数据，False就会返回response
'''
response_json,code = ap.api_run(request, url, method=None, parameter={'a':1}, json=True)

执行前钩子

before_running

执行后钩子

after_running

钩子例子

class CommonApi(ApiShop):
    def before_running(self, **kwargs):
        print('运行前钩子',kwargs)
        if kwargs.get('key')=='addroute/mock':
            return JsonResponse({'msg':'您没有权限'}, status=400)
    def after_running(self, **kwargs):
        print('运行后钩子',kwargs)

af = CommonApi(conf, {
    'framework': 'django',
    'lang': 'zh'
})

路由装饰器

TIP

在 Api 继承对象前使用 @add_api 类装饰器添加路由和参数，这样就无须使用 conf 集中配置文件

@af.add_api(
    name='装饰器模式接口',
    url=['addroute/mock/<username>','addroute/test'],
    methods={
        'GET':[
            {'name':'username','required':True, 'type': str, 'min': 3, 'max': 24, 'description': '用户名'},
        ]
    }
)
class ApiMockTest(Api):
    def get(self, request, data):
        print('get',data)