programmingModel

Свойство schema.org ^?

Канонический URL: https://schema.org/programmingModel
👉 Проверить на наличие открытых проблем.

Содержание: Описание, Какие должны быть типы, В каких типах используется, Примеры использования.

Описание:

Указывает, управляется ли API или нет.

Свойство programmingModel в Schema.org используется для указания типа управления API, то есть, как именно API управляется и разрабатывается. Это свойство помогает разработчикам и пользователям понять, каким образом взаимодействовать с API и какие особенности он имеет.

Основная цель programmingModel — предоставить информацию о том, является ли API управляемым или неуправляемым. Управляемый API подразумевает, что он контролируется и поддерживается какой-либо платформой или сервисом, что может включать в себя автоматическое масштабирование, безопасность и другие функции, которые упрощают его использование. Неуправляемый API, с другой стороны, предоставляет больше свободы и гибкости для разработчиков, но требует от них большей ответственности за управление и поддержку.

Это свойство используется в контексте описания API, что позволяет пользователям и разработчикам лучше понять, как они могут интегрировать и использовать данный API в своих приложениях. Указание типа программной модели помогает создавать более прозрачные и понятные интерфейсы, что, в свою очередь, может повысить уровень доверия и удобства для конечных пользователей.

В общем, programmingModel является важным элементом для описания API, так как он помогает в классификации и понимании его особенностей, что облегчает разработку и использование программных решений.

Ожидается, что значения будут одного из этих типов

Text ^?

Используется в этих типах

APIReference ^?

Примеры

Пример 1

Это пример от schema.su, его нету в официальной документации! Будьте внимательны, работоспособность не можем гарантировать. Проверяйте через валидатор.

Пример заметки или HTML разметки.

<div>
  <h1>Документация API для системы электронных платежей "ПлатиОнлайн"</h1>
  <p>API предоставляет интерфейсы для выполнения операций по приему платежей, проверке статуса транзакций и управления учетными записями.</p>
  <p>Версия сборки: 2.5.0</p>
  <p>Поддерживаемые платформы: Linux, Windows, macOS</p>
  <a href="https://example.com/api-documentation">Просмотр документации</a>
</div>

Пример, закодированный в формате Microdata, встроенный в HTML.

<div itemscope itemtype="https://schema.org/APIReference">
  <h1 itemprop="name">Документация API для системы электронных платежей "ПлатиОнлайн"</h1>
  <p itemprop="description">API предоставляет интерфейсы для выполнения операций по приему платежей, проверке статуса транзакций и управления учетными записями.</p>
  <p>Версия сборки: <span itemprop="assemblyVersion">2.5.0</span></p>
  <p>Поддерживаемые платформы: <span itemprop="targetPlatform">Linux, Windows, macOS</span></p>
  <a itemprop="url" href="https://example.com/api-documentation">Просмотр документации</a>
  <meta itemprop="programmingModel" content="RESTful" />
</div>

Пример, закодированный в формате JSON-LD в теге <script> HTML.

<script type="application/ld+json">
{
  "@context": "https://schema.org",
  "@type": "APIReference",
  "name": "Документация API для системы электронных платежей \"ПлатиОнлайн\"",
  "description": "API предоставляет интерфейсы для выполнения операций по приему платежей, проверке статуса транзакций и управления учетными записями.",
  "url": "https://example.com/api-documentation",
  "assemblyVersion": "2.5.0",
  "targetPlatform": ["Linux", "Windows", "macOS"],
  "programmingModel": "RESTful"
}
</script>

Структурированное представление примера JSON-LD.

@context

https://schema.org

@type

APIReference

name

Документация API для системы электронных платежей "ПлатиОнлайн"

description

API предоставляет интерфейсы для выполнения операций по приему платежей, проверке статуса транзакций и управления учетными записями.

url

https://example.com/api-documentation

assemblyVersion