python-spacetraders

访问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[MyDataModel] = 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类上有更多设置，允许你控制更多运行时行为，请查看该类的文档字符串以获取更多信息。

需要注意的事情

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. 从其他项目安装该wheelpip install <wheel的路径>