主要介绍一下基于文件管理的接口格式,数据库管理的接口待页面开发完成之后补全。
每一个接口都由接口头和接口内容两部分组成,接口头保存接口的设置信息,接口内容即接口的逻辑,由 PQL 编写。如下示例:
上例中声明了 4 个接口,接口头的设置都有所不同。现在将关键点分别说明一下:
##
开始。test
为接口名称,接口名称一般为一个单词,如果是多个单词,单词之间使用中横线-
隔开,接口名称全部小写,可以包含数字。接口名是接口地址路径中的最后一部分。GET
、PUT
、POST
和DELETE
为接口请求方法。在一个项目中,接口可以重名,但“接口名+请求方法”须唯一,出现重复后面定义的接口会覆盖前面的。只能设置一个请求方法。name=Tom&age=18&score=89
。如果用户请求接口时未传递某个参数,则使用默认值代替。,
隔开,即允许哪些请求者访问这个接口。一定注意这里控制的是 请求方法Method+接口名称。这里一般填写用户名或角色名,多个用户名或角色名之间使用逗号,
分隔,表示这些用户或角色可以访问这个接口。可以对接口访问进行批量控制,请参阅访问控制,|
分隔,最后一项后面可以省略竖线。#{id}
、#{score}
和#{'name'}
为接口参数,详细内容请参阅向 OneApi 传递参数。;
结束。语句之间可以空行。最后一条语句的分号可省略。请参阅 PQL 基础文档待完善。
参考链接