spacetraders python客户端

访问SpaceTraders API的客户端库

用法

首先，创建一个客户端

from spacetraders import Client

client = Client(base_url="https://api.spacetraders.io/v2")

如果你要调用的端点需要身份验证，请使用AuthenticatedClient代替

from spacetraders import AuthenticatedClient

client = AuthenticatedClient(base_url="https://api.spacetraders.io/v2", token="SuperSecretToken")

现在调用你的端点并使用你的模型

from spacetraders.models import GetMyAgentResponse200
from spacetraders.types import Response

response: Response[GetMyAgentResponse200] = client.agents.get_my_agent()

或者使用异步版本做同样的事情

from spacetraders.models import GetMyAgentResponse200
from spacetraders.types import Response

response: Response[GetMyAgentResponse200] = await client.agents.get_my_agent()

默认情况下，当你调用HTTPS API时，它会尝试验证SSL是否正确工作。使用证书验证在大多数情况下都是强烈推荐的，但有时你可能需要使用自定义证书包对服务器进行身份验证（特别是内部服务器）。

client = AuthenticatedClient(
    base_url="https://internal_api.example.com", 
    token="SuperSecretToken",
    verify_ssl="/path/to/certificate_bundle.pem",
)

你也可以完全禁用证书验证，但请注意，这是一个安全风险。

client = AuthenticatedClient(
    base_url="https://internal_api.example.com", 
    token="SuperSecretToken", 
    verify_ssl=False
)

生成的Client类上还有更多设置，可以让你控制更多运行时行为，有关更多信息，请查看该类的docstring。

注意事项

1. 所有路径/查询参数和体都成为方法参数。
2. 标记的端点将使用第一个标记作为函数的模块名
3. 没有标记的任何端点将位于client.default

刷新API定义

此项目是从SpaceTradersAPI/api-docs生成的。以下步骤概述了如何从新架构刷新

1. 将要生成的api-docs版本克隆到另一个目录中 git clone https://github.com/SpaceTradersAPI/api-docs /tmp/api-docs
2. 导航到/tmp/api-docs并生成单个OpenAPI包 npx @redocly/openapi-cli@latest bundle -o bundle.json
3. 在此项目目录中，使用以下命令刷新生成的类：poetry run openapi-python-client update --path /tmp/api-docs/bundle.json --meta none --config openapi-client.yml --custom-template-path=openapi-client-template

构建/发布此客户端

本项目使用 Poetry 管理依赖和打包。以下是基础知识

1. 更新 pyproject.toml 中的元数据（例如作者、版本）
2. 使用 poetry publish --build -r <你的仓库名称> 发布客户端，或者如果是在公共 PyPI 上，只需 poetry publish --build

如果您想在未发布的情况下将此客户端安装到另一个项目中（例如开发）

1. 如果那个项目 正在使用 Poetry，您可以从那个项目简单地执行 poetry add <此客户端的路径>
2. 如果那个项目没有使用 Poetry
   1. 使用 poetry build -f wheel 构建一个 wheel
   2. 从其他项目安装该 wheel pip install <wheel 的路径>