mirrors/EWF
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated Documentation (markdown)

Browse Source
This commit is contained in:
Jocelyn Fiat
2014-01-07 04:22:11 -08:00
parent 2fb521aa42
commit 093dec1808
1 changed files with 8 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
Documentation.md
View File

@@ -29,6 +29,7 @@ For convenience, the framework provides richer service interface that handles th
<a name="wiki-request"/><a name="wiki-response"/><a name="wiki-request-and-response"/> <a name="wiki-request"/><a name="wiki-response"/><a name="wiki-request-and-response"/>
# Request and Response # Request and Response
> see interface: **WSF_REQUEST** and **WSF_RESPONSE** > see interface: **WSF_REQUEST** and **WSF_RESPONSE**
Any incoming http request is represented by an new object of type **WSF_REQUEST**. Any incoming http request is represented by an new object of type **WSF_REQUEST**.
**WSF_REQUEST** provides access to **WSF_REQUEST** provides access to
@@ -107,6 +108,7 @@ Examples
# EWF components # EWF components
## URI Handler: ## URI Handler:
> Parses the details of the URI (scheme, path, query info, etc.) and exposes them for use. > Parses the details of the URI (scheme, path, query info, etc.) and exposes them for use.
How we do that in EWF?: URI Templates, but we could also use regex. How we do that in EWF?: URI Templates, but we could also use regex.
Related code: uri_template Related code: uri_template
Examples: Examples:
@@ -114,12 +116,14 @@ Examples:
## Mime Parser/ Content Negotiation: ## Mime Parser/ Content Negotiation:
> Handles the details of determining the media type, language, encoding, compression (conneg). > Handles the details of determining the media type, language, encoding, compression (conneg).
How do we do that in EWF? Content_Negotiation library. How do we do that in EWF? Content_Negotiation library.
Example Example
## Request Handler ## Request Handler
> target of request dispatcher + uri handler. > target of request dispatcher + uri handler.
Here is where we handle GET, POST PUT, etc. Here is where we handle GET, POST PUT, etc.
## Representation Mapping ## Representation Mapping
@@ -131,22 +135,23 @@ to the developer to map their domain to the target representation.
## Http Client: ## Http Client:
> A simple library to make requests and handle responses from other http servers. > A simple library to make requests and handle responses from other http servers.
How we do that in EWF? http client library How we do that in EWF? http client library
examples: examples:
## Authentication/Security: ## Authentication/Security:
> Handle different auth models. (Basic, Digest?, OAuth, OpenId) > Handle different auth models. (Basic, Digest?, OAuth, OpenId)
How we do that in EWF? http_authorization, OpenId, and Cypress How we do that in EWF? http_authorization, OpenId, and Cypress
examples. examples.
## Caching: ## Caching:
> Support for Caching and conditional request > Support for Caching and conditional request
How we do that in Eiffel? Policy framework on top of EWF. {{{need_review}}} How we do that in Eiffel? Policy framework on top of EWF. {{{need_review}}}
examples examples
## EWF HTML5 Widgets ## EWF HTML5 Widgets
## EWF policy Framework ## EWF policy Framework