AmiyaBotHTTP服务器支持
AmiyaBot 内置了基于 FastApi 的HTTP服务构建工具。
创建服务
HttpServer 类
| 参数名 | 类型 | 释义 | 默认值 |
|---|---|---|---|
| host | str | 服务监听地址 | |
| port | int | 服务监听端口 | |
| title | str | swagger 页面标题 | AmiyaBot |
| description | str | swagger 页面注释 | https://www.amiyabot.com |
| auth_key | str | 请求头密钥 | |
| fastapi_options | dict | FastAPI **kwargs | |
| uvicorn_options | dict | uvicorn.Config **kwargs |
python
from amiyabot import HttpServer
server = HttpServer(host='0.0.0.0', port=8088)
@server.controller
class Bot:
@server.route(method='get')
async def get_name(self):
return 'AmiyaBot'
@server.route(method='post')
async def say_hello(self):
return server.response(message='hello')
asyncio.run(server.serve())运行代码，访问 http://127.0.0.1:8088/docs 即可看到生成了如下两个接口。
/bot/getName
/bot/sayHello自定义路由
接口的路由将默认使用控制器类名以及方法名组成，如果需要自定义路由，在方法装饰器 route 传入 router_path 参数即可。
python
@server.route(method='get', router_path='/custom/getBotName')
async def get_name(self):
...请求头密钥
在创建 HttpServer 时传入 auth_key 参数，则在调用接口时，需要在请求头（Header）里添加 authKey 字段并匹配参数的值，才允许访问。
python
server = HttpServer(..., auth_key='my_auth_key')FastApi 扩展
AmiyaBot 仅对 FastApi 的路由注册做了简易的封装。如需要扩展其用法，可获取 app 实例后参考官方文档进一步使用。
python
server = HttpServer()
app: FastAPI = server.app