APIs.json Metadata Format

A Simple Format for Publishing API Meta Data on the Web

The objective of the format defined in this document is to provide a lightweight means for individuals and organizations to document the location of their APIs, the associated descriptions, human and machine readable specification and ancillary information (such as licensing, maintainers and so forth). See specification for details.

• ALPS
• Application State Diagram
• Semantic Descriptors
  • adr (semantic), Physical address
  • apis (semantic), List of APIs identified in the file
  • apisJSON (semantic), APIs.json resource
  • baseUrl (semantic), Web URL
  • common (semantic), List of common properties
  • contact (semantic)
  • created (semantic), Creation date of the file
  • data (semantic), The data for the property
  • description (semantic), Description of the collection
  • email (semantic), Email Address
  • fn (semantic), Full Name
  • goAPIsJSON (safe), Navigate to the APIs.json resource
  • goHome (safe), Navigate to the home resource
  • home (semantic), Home resource
  • humanUrl (semantic), Web URL
  • image (semantic), Web URL leading to associated image
  • include (semantic), List of APIs.json files referenced.
  • maintainers (semantic), List of people/orgs maintaining this file
  • mediaType (semantic), IANA media type
  • modified (semantic), Date of last modification of this file
  • name (semantic), Name of API or collection
  • org (semantic), Organization
  • photo (semantic), URL
  • properties (semantic), collection
  • resources (semantic), List of resources available for API operations.
  • specifications (semantic), List of open specifications
  • specificationVersion (semantic), Version of APIs.json specification in use.
  • tags (semantic), Array of descriptive strings
  • tel (semantic), Phone number
  • tools (semantic), List of open source tooling
  • type (semantic), Type of collection
  • url (semantic), Web URL
  • vCard (semantic), URL pointing to a vCard
  • version (semantic), String representing the version number
  • x-github (semantic), org/person's account
  • x-twitter (semantic), org/person's account
  • XXX (semantic)
• Tags
  • VCARD
  • choreography
  • group
  • ontology
  • taxonomy