Skip to content
Erik Wilde edited this page Apr 11, 2016 · 6 revisions

Home Documents for HTTP APIs

This is a tracking page for the Home Documents for HTTP APIs specification.

Status

The specification is effectively on hold, pending more feedback and implementation. I've received a fair amount of positive support for this effort, but not enough to indicate that it's either done, or worth pushing to a full standard. So, if you want to see a son-home RFC, please get involved!

Get Involved

You can get involved in the specification by:

  • Opening and/or adding to issues about it
  • Discussing it using the annotations bar on the HTML spec
  • Listing your implementation and/or use case below

Use Cases and Benefits

Having a home page for a HTTP API has a lot of benefits, such as the ability to host multiple APIs on the same server without collisions, better versioning, and the ability to layer in things like RBAC. What else do you think you get by using a home document?

Implementations

If you use API Home documents in your application, have software that produces or consumes them, or otherwise implement the spec (either in its JSON or XML form), please list it here, with a link. Closed source is fine too.

Clone this wiki locally