Introduction
FOAAS (Fuck Off As A Service) provides a modern, RESTful, scalable solution to the common problem of telling people to fuck off.
API
Content Negotiation
FOAAS will respond to the following 'Accept:' values with appropriate content
- text/plain - Content will be returned as a plain string.
-
application/json - Content will be returned as a JSON object
{ message: 'message', subtitle: 'subtitle' }- Supports jsonp by including
?callback=?
- Supports jsonp by including
- text/html - Content will be returned as an HTML page with a twitter bootstrap hero unit, containing the message and the subtitle.
- application/xml - Content will be returned as a XML document.
Operations
| Path | Description |
|---|---|
| /version | Will return content with the current FOAAS version number. |
| /operations | Will return a JSON list of operations with names and fields. Note: JSON Only |
Filters
Filters are optional output modifiers, and are specified by adding the filter name as query to the HTTP request, e.g. http://foaas.com/off/Tom/Everyone?shoutcloud.
Caveat: All filters internally call the stated external services, and as such the latency and availability of API calls using these features cannot be guaranteed.
| Name | Description |
|---|---|
| shoutcloud | Integration with the ShoutCloud service. Please see shoutcloud.io for details. |
| i18n | Translation provided by mymemory.translated.net. Specifying ?i18n on its own will attempt to detect your browser language, or you can specify the language to translate to using the ISO 639-1 language code, i.e. ?i18n=es |
Filters can be used in combinations, e.g. http://foaas.com/off/Tom/Everyone?shoutcloud&i18n=de
Roadmap
FOAAS will be extended to include the following functionality:
- Random fuck offs (or Fuck Off of the Day), without having to specify the operation (off, you, everyone, donut etc) explicitly
All contributions are very welcome.
Created by @TomDionysus
Maintained with loving Profanity by @philip2156, @chris_beckett