Основные принципы организации API
Проект YourMaps предоставляет HTTP API. Основные принципы организации API:
- Все методы возвращают HTTP код 200 независимо от результата, реальный результат содержится внутри ответа в виде JSON структуры. Коды, отличные от 200, означают сбой в работе сервера.
- В каждом ответе есть поля code и message. Первое содержит в себе число – результат выполнения запроса, второе содержит дополнительное сообщение.
Поскольку эти поля присутствуют во всех ответах сервера, ниже в описании методов они не будут упоминаться, будут перечислены только дополнительные поля, если они есть. - Авторизация осуществляется по токену, передаваемому в каждый запрос в хедере AuthToken
- Методы, изменяющие состояние сервера, вызываются POST запросами, остальные – GET
OpenAPI
Актуальное описание методов API доступно в формате OpenAPI v3 по ссылке https://yourmaps.io/openapi/v3/api-docs
Оно может использоваться сторонними инструментами для генерации человекочитаемой документации, или для автоматического создания клиентов и схем запросов. Описание спецификации и ссылки на инструменты можно найти на сайте https://swagger.io/
По ссылке https://yourmaps.io/openapi/v3/swagger-ui/ доступна сгенерированная Swagger документация. Там находятся описания методов, структура ответов, прямо с этой же страницы можно менять параметры и запускать методы.
