Building Hypermedia APIs with HTML5 and Node

Appendix F. Microblogging HTML Semantic Profile

The purpose of a Semantic Profile is to document the application-level semantics of a particular implementation. This is accomplished by describing elements of response representations for a target media type. For example, identifying markup elements returned (i.e. semantic HTML with Microformats) and state transitions (i.e. HTML.A and HTML.FORM elements) that advance the state of the current application.

It should be noted that this documentation does not contain any of the following:

• URI construction rules

• Suggested resource names

• HTTP request/response samples

• Example resource representations

This work was inspired by Roy T. Fielding’s “REST APIs must be hypertext driven” blog post. The implementation approach is based on Tantek Çelik’s HTML Meta Data Profiles.

General Concepts

The profile here contains details on customizing the HTML media type for a specific application domain: microblogging. It contains descriptions of valid @class, @id, @name, and @rel values that can appear within HTML resource representations. The identified base media type (HTML) along with the list of attributes, values, and their meaning describes a hypermedia interface. This document is presented as a complete blueprint for implementing a compliant client or server that supports the basic features of the target application domain (microblogging).

Compliance

An implementation is not compliant if it fails to satisfy one or more of the MUST or REQUIRED level requirements. ...