WebAPI - микроразметка schema.org

WebAPI - Описание микроразметки для WebAPI на сайте schema.su.

WebAPI - Тип Schema.org

Описание: Микроразметка WebAPI - Тип schema.org для определения интерфейса прикладного программирования, к которому можно получить доступ через технологии Web/интернет.

Микроразметка WebAPI используется для определения интерфейса прикладного программирования, к которому можно получить доступ через технологии Web/интернет.

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

Свойство	Ожидаемый тип	Описание
Properties from WebAPI
`documentation`	CreativeWork или URL	Дальнейшая документация, описывающая веб-API более детально.
Properties from Service
`aggregateRating`	AggregateRating	Общий рейтинг, основанный на коллекции отзывов или оценок элемента.
`areaServed`	AdministrativeArea или GeoShape или Place или Text	Географическая область, где предоставляется услуга или продукт. Supersedes serviceArea.
`audience`	Audience	Целевая аудитория, т.е. группа людей, для которой что-то было создано. Supersedes serviceAudience.
`availableChannel`	ServiceChannel	Средство доступа к сервису (например, телефонный банк, веб-сайт, местоположение и т. д.).
`award`	Text	Награда, выигранная или присужденная этому элементу. Supersedes awards.
`brand`	Brand или Organization	Бренд(ы), связанные с продуктом или услугой, или бренд(ы), поддерживаемые организацией или бизнес-персоной.
`broker`	Organization или Person	Сущность, которая организует обмен между покупателем и продавцом. В большинстве случаев брокер никогда не приобретает или не освобождает владение продуктом или услугой, участвующими в обмене. Если не ясно, является ли сущность брокером, продавцом или покупателем, предпочтение отдается последним двум терминам. Supersedes bookingAgent.
`category`	CategoryCode или PhysicalActivityCategory или Text или Thing или URL	Категория для элемента. Большие знаки больше или косые черты могут использоваться неформально для обозначения иерархии категорий.
`hasCertification`	Certification	Сертификация информации о продукте, организации, услуге, месте или человеке.
`hasOfferCatalog`	OfferCatalog	Свидетельствует о наличии списка OfferCatalog для этой Организации, Человека или Сервиса.
`hoursAvailable`	OpeningHoursSpecification	Часы, в течение которых этот сервис или контакт доступен.
`isRelatedTo`	Product или Service	Ссылка на другой, как-то связанный продукт (или несколько продуктов).
`isSimilarTo`	Product или Service	Указатель на другой, функционально похожий продукт (или несколько продуктов).
`logo`	ImageObject или URL	Ассоциированный логотип.
`offers`	Demand или Offer	An offer to provide this itemâ€”for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use businessFunction to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a Demand. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. Обратное свойство: itemOffered
`provider`	Organization или Person	Поставщик услуг, оператор услуг или исполнитель; производитель товаров. Другая сторона (продавец) может предлагать эти услуги или товары от имени поставщика. Поставщик также может выступать в роли продавца. Supersedes carrier.
`providerMobility`	Text	Указывает на мобильность предоставляемой услуги (например, 'статическая', 'динамическая').
`review`	Review	Рецензия на объект. Supersedes reviews.
`serviceOutput`	Thing	Конкретная вещь, созданная услугой, например, паспорт, разрешение и т. д. Supersedes produces.
`serviceType`	GovernmentBenefitsType или Text	Тип предлагаемой услуги, например, льготы для ветеранов, чрезвычайная помощь и т. д.
`slogan`	Text	Слоган или девиз, связанный с объектом.
`termsOfService`	Text или URL	Человекочитаемая документация о правилах обслуживания.
Properties from Thing
`additionalType`	Text или URL	An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. Typically the value is a URI-identified RDF class, and in this case corresponds to the use of rdf:type in RDF. Text values can be used sparingly, for cases where useful information can be added without their being an appropriate schema to reference. In the case of text values, the class label should follow the schema.org style guide.
`alternateName`	Text	Псевдоним для элемента.
`description`	Text или TextObject	Описание элемента.
`disambiguatingDescription`	Text	Подсвойство описания. Краткое описание элемента, используемое для различения от других, схожих элементов. Для того чтобы описание было полезным для разрешения неоднозначности, может потребоваться информация из других свойств (в частности, name).
`identifier`	PropertyValue или Text или URL	The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details.
`image`	ImageObject или URL	An image of the item. This can be a URL or a fully described ImageObject.
`mainEntityOfPage`	CreativeWork или URL	Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. Обратное свойство: mainEntity
`name`	Text	Название элемента.
`potentialAction`	Action	Указывает на потенциальное действие, описывающее идеализированное действие, в котором этот объект мог бы выполнять роль 'объекта'.
`sameAs`	URL	URL страницы для ссылки, однозначно указывающей на идентичность объекта. Например, URL страницы объекта на Википедии, записи в Wikidata или официального веб-сайта.
`subjectOf`	CreativeWork или Event	Свойство Schema.org - subjectOf: A CreativeWork or Event about this Thing. Обратное свойство: about
`url`	URL	URL объекта.

Source

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

Examples

Example 1

No Markup JSON-LD Structure

Example notes or example HTML without markup.

See JSON example.

Example encoded as JSON-LD in a HTML script tag.

<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>

Structured representation of the JSON-LD example.

WebAPI - микроразметка schema.org

Source

Examples

Обсуждение "WebAPI"