WebAPI

Тип schema.org ?

Этот термин находится в "новой" области — обратная связь по реализации и использование в приложениях и на веб-сайтах могут помочь улучшить определения.

Thing > Intangible > Service > WebAPI

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

Содержание: Описание, Свойства которые можно использовать, Ссылка на источник термина, Примеры использования.

Описание:

Интерфейс программирования приложений, доступный через технологии Web/Internet.

WebAPI — это тип Schema.org, который описывает интерфейс программирования приложений, доступный через веб-технологии. Он представляет собой набор правил и протоколов, которые позволяют различным программным приложениям взаимодействовать друг с другом через интернет.

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

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

WebAPI также поддерживает различные форматы данных, такие как JSON и XML, что делает его универсальным инструментом для передачи информации между различными платформами и языками программирования. Это значит, что разработчики могут использовать WebAPI для создания приложений, которые работают на разных устройствах и операционных системах, обеспечивая при этом совместимость и взаимодействие.

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

Свойство	Ожидаемый тип	Описание
Свойство из WebAPI
documentation	CreativeWork, URL	Дальнейшая документация, описывающая Web API более подробно.
Свойство из Service
aggregateRating	AggregateRating	Общая оценка, основанная на совокупности отзывов или оценок, данного объекта.
areaServed	AdministrativeArea, Text, GeoShape, Place	Географическая область, где предоставляется услуга или предлагаемый товар.
audience	Audience	Предназначенная аудитория, т.е. группа, для которой что-то было создано.
availableChannel	ServiceChannel	Средство доступа к услуге (например, телефонный банк, веб-сайт, место и т.д.).
award	Text	Награда, полученная этим элементом или за него.
brand	Brand, Organization	Бренд(ы), ассоциированные с продуктом или услугой, или бренд(ы), поддерживаемые организацией или бизнесменом.
broker	Person, Organization	Сущность, которая организует обмен между покупателем и продавцом. В большинстве случаев брокер никогда не приобретает и не передает право собственности на продукт или услугу, участвующие в обмене. Если неясно, является ли сущность брокером, продавцом или покупателем, предпочтение следует отдавать последним двум терминам.
category	CategoryCode, PhysicalActivityCategory, Text, Thing, URL	Категория для элемента. Большие знаки или косые черты могут быть использованы для неформального указания иерархии категорий.
hasCertification	Certification	Информация о сертификации продукта, организации, услуги, места или человека.
hasOfferCatalog	OfferCatalog	Указывает на список OfferCatalog для этой Организации, Лица или Услуги.
hoursAvailable	OpeningHoursSpecification	Часы, в течение которых эта услуга или контакт доступны.
isRelatedTo	Service, Product	Указатель на другой, каким-то образом связанный продукт (или несколько продуктов).
isSimilarTo	Product, Service	Указатель на другой, функционально схожий продукт (или несколько продуктов).
logo	ImageObject, URL	Ассоциированное лого.
offers	Demand, Offer	Предложение предоставить этот товар — например, предложение продать продукт, арендовать DVD фильма, выполнить услугу или раздать билеты на мероприятие. Используйте businessFunction, чтобы указать вид предлагаемой транзакции, т.е. продажу, аренду и т.д. Это свойство также может быть использовано для описания Demand. Хотя это свойство указано как ожидаемое для ряда общих типов, оно может быть использовано и в других. В этом случае использование второго типа, такого как Product или подтипа Product, может прояснить природу предложения.
provider	Person, Organization	Поставщик услуг, оператор услуг или исполнитель услуг; производитель товаров. Другая сторона (продавец) может предлагать эти услуги или товары от имени поставщика. Поставщик также может выступать в качестве продавца.
providerMobility	Text	Указывает на мобильность предоставляемой услуги (например, 'статическая', 'динамическая').
review	Review	Обзор предмета.
serviceOutput	Thing	Осязаемая вещь, созданная сервисом, например, паспорт, разрешение и т.д.
serviceType	GovernmentBenefitsType, Text	Тип услуги, которая предлагается, например, льготы для ветеранов, экстренная помощь и т.д.
slogan	Text	Слоган или девиз, связанный с предметом.
termsOfService	Text, URL	Документация условий обслуживания на понятном языке.
Свойство из Thing
additionalType	URL, Text	Дополнительный тип для элемента, обычно используемый для добавления более специфичных типов из внешних словарей в синтаксисе микроданных. Это отношение между чем-то и классом, к которому это что-то относится. Обычно значение является URI-идентифицированным классом RDF, и в этом случае соответствует использованию rdf:type в RDF. Текстовые значения могут использоваться экономно, в случаях, когда полезная информация может быть добавлена без наличия соответствующей схемы для ссылки. В случае текстовых значений, метка класса должна следовать руководству по стилю schema.org.
alternateName	Text	Псевдоним для элемента.
description	Text, TextObject	Описание предмета.
disambiguatingDescription	Text	Субсвойство описания. Краткое описание элемента, используемое для различения его от других, похожих элементов. Информация из других свойств (в частности, имени) может быть необходима для того, чтобы описание было полезным для различения.
identifier	PropertyValue, Text, URL	Свойство identifier представляет собой любой вид идентификатора для любого рода Thing, такого как ISBN, коды GTIN, UUID и т.д. Schema.org предоставляет специальные свойства для представления многих из них, как в виде текстовых строк, так и в виде ссылок URL (URI). См. фоновую информацию для получения дополнительных деталей.
image	ImageObject, URL	Изображение предмета. Это может быть URL или полностью описанный ImageObject.
mainEntityOfPage	CreativeWork, URL	Указывает на страницу (или другое творческое произведение), для которой этот объект является основным описываемым объектом. См. фоновую информацию для получения деталей.
name	Text	Название элемента.
potentialAction	Action	Указывает на потенциальное действие, которое описывает идеализированное действие, в котором этот объект будет играть роль 'объекта'.
sameAs	URL	URL страницы в Интернете, которая однозначно указывает на идентичность элемента. Например, URL страницы элемента в Википедии, запись в Викиданных или официальный сайт.
subjectOf	CreativeWork, Event	Творческое произведение или событие, связанное с этой вещью.
url	URL	URL предмета.

Источник

https://github.com/schemaorg/schemaorg/issues/1423

Примеры

Пример 1

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


See JSON example.

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


<script type="application/ld+json">
{
  "@context": "https://schema.org/",
  "@type": "WebAPI",
  "name": "Google Knowledge Graph Search API",
  "description": "The Knowledge Graph Search API lets you find entities in the Google Knowledge Graph. The API uses standard schema.org types and is compliant with the JSON-LD specification.",
  "documentation": "https://developers.google.com/knowledge-graph/",
  "termsOfService": "https://developers.google.com/knowledge-graph/terms",
  "provider": {
    "@type": "Organization",
    "name": "Google Inc."
  }
}
</script>

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

@context

https://schema.org/

@type

WebAPI

name

Google Knowledge Graph Search API

description

The Knowledge Graph Search API lets you find entities in the Google Knowledge Graph. The API uses standard schema.org types and is compliant with the JSON-LD specification.

documentation

https://developers.google.com/knowledge-graph/

termsOfService

https://developers.google.com/knowledge-graph/terms

provider

@type: Organization
name: Google Inc.

Автор: Семён Авдосов [schema.su]

Дата публикации: 16.11.2024

Дата обновления: 20.11.2024

Комментарии