Web API (WebAPI) Schema Generator and How to Guide
WebAPI Schema Markup
An application programming interface accessible over Web/Internet technologies.
WebAPI schema is a sub type of:
This schema has no sub types
WebAPI Schema Generator in JSON-LD
WebAPI schema code:
Guide on How to Create a WebAPI Schema
Step 1: Fill out the form above as much as possible.
Note:Use this Schema.org based structured data generator tool to easily create WebAPI schema.
The properties are the description of your entity. You don't have to fill in all the properties on this page. Provide what is available and leave what is not. To learn more about each property in your schema type please check WebAPI schema properties
Step 2: When complete click the Copy Code button to get your JSON-LD code
Notes:To check if your code is eligible for featured snippets (rich snippets or rich results) test your code with the Rich Results Test tool to learn more about which schema are qualified for rich results check out Google’s search gallery.
To validate your markup code, check your JSON-LD code with the Schema Markup Validator
Step 3: To add a sub-schema, click on the Create Knowledge Graph button
Important Notes: to describe the relationship between your entities you must design a custom schema, this is where the 'creation of knowledge graph' is needed.
For example: if you have a local business and you want to add a service catalogue, or if you have a recipe schema and you want to add a HowTo steps, or if you have a product and you want to add a FAQ about it, to learn more watch this semantic SEO workshop
WebAPI Schema Properties
WebAPI has 37 properties:
- additionalType 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. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
- aggregateRating The overall rating, based on a collection of reviews or ratings, of the item.
- alternateName An alias for the item.
- areaServed The geographic area where a service or offered item is provided.
- audience An intended audience, i.e. a group for whom something was created.
- availableChannel A means of accessing the service (e.g. a phone bank, a web site, a location, etc.).
- award An award won by or for this item.
- brand The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.
- broker An entity that arranges for an exchange between a buyer and a seller. In most cases a broker never acquires or releases ownership of a product or service involved in an exchange. If it is not clear whether an entity is a broker, seller, or buyer, the latter two terms are preferred.
- category A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.
- description A description of the item.
- disambiguatingDescription A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
- documentation Further documentation describing the Web API in more detail.
- hasOfferCatalog Indicates an OfferCatalog listing for this Organization, Person, or Service.
- hoursAvailable The hours during which this service or contact is available.
- identifier 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 An image of the item. This can be a URL or a fully described ImageObject.
- isRelatedTo A pointer to another, somehow related product (or multiple products).
- isSimilarTo A pointer to another, functionally similar product (or multiple products).
- logo An associated logo.
- mainEntityOfPage Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details.
- name The name of the item.
- offers 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.
- potentialAction Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
- produces The tangible thing generated by the service, e.g. a passport, permit, etc.
- provider The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
- providerMobility Indicates the mobility of a provided service (e.g. 'static', 'dynamic').
- review A review of the item.
- sameAs URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
- serviceArea The geographic area where the service is provided.
- serviceAudience The audience eligible for this service.
- serviceOutput The tangible thing generated by the service, e.g. a passport, permit, etc.
- serviceType The type of service being offered, e.g. veterans' benefits, emergency relief, etc.
- slogan A slogan or motto associated with the item.
- subjectOf A CreativeWork or Event about this Thing.
- termsOfService Human-readable terms of service documentation.
- url URL of the item.