Спецификации OpenAPI
Каждое семейство API FastNear опубликовано как документ OpenAPI, который можно получить напрямую, а каждая операция опубликована ещё и отдельно. Если вы инструмент или агент, начните с индекса:
curl -s https://docs.fastnear.com/openapi/index.jsonДокументы семейств
| Семейство | OpenAPI | Документация |
|---|---|---|
| FastNEAR RPC (JSON-RPC) | JSON · YAML | Справочник RPC |
| FastNEAR API | JSON · YAML | FastNear API |
| Transactions API | JSON · YAML | Transactions API |
| Transfers API | JSON · YAML | Transfers API |
| KV FastData API | JSON · YAML | KV FastData API |
| NEAR Data API | JSON · YAML | NEAR Data API |
Каждый документ содержит собственные servers, security и схемы компонентов, поэтому его можно импортировать в любой инструмент OpenAPI или генератор клиентов как есть. Документ RPC описывает каждый JSON-RPC-метод как отдельный путь, например /view_account, и все они отправляются POST-запросом в корень сервера.
Документы отдельных операций
Каждая операция также доступна как самостоятельный документ по адресу /openapi/<family>/<operationId>.json (или .yaml), например:
https://docs.fastnear.com/openapi/rpc/view_account.json
https://docs.fastnear.com/openapi/fastnear/account_full_v1.jsonИндекс перечисляет каждую операцию с её operationId, собственным документом, страницей документации и ссылкой-указателем JSON внутрь документа семейства, например /openapi/rpc.json#/paths/~1view_account/post.
Где находятся ссылки
- На каждой странице операции есть строка OpenAPI со ссылками на её собственный документ и на документ семейства.
- Каждая обзорная страница семейства ссылается на свой документ в разделе Базовые URL.
- В заголовке страниц есть
<link rel="service-desc" type="application/vnd.oai.openapi+json">для документа семейства иrel="describedby"для документа операции, чтобы краулеры и агенты находили спецификацию, не читая страницу. - Markdown-зеркала,
llms.txtи граф сайта содержат те же URL.
Аутентификация
Передавайте API-ключ FastNear в заголовке Authorization: Bearer или в параметре запроса ?apiKey=; см. Аутентификацию и доступ. Блок security в каждом документе перечисляет обе формы.