facil.io icon indicating copy to clipboard operation
facil.io copied to clipboard

the version 07.x of document is too concise so that it's so difficult to use

Open immortalChensm opened this issue 4 years ago • 2 comments

for example I want to know how i can obtain method of http request or body code is request->method??? but nothing I have to read more source code,it's will spend my much more time to understand Document description too little

immortalChensm avatar Dec 04 '19 06:12 immortalChensm

Hi @immortalChensm ,

Thank you for opening this issue. You definitely make a fair point.

I would love to get some help with the documentation... especially as there will be a lot of breaking changes in the 0.8.0 version (I'm working on unifying the API styles in the different extensions and types).

If you have any specific changes you wish to propose, please feel free to submit a PR with updates to the documentation files (in ./docs/_SOURCE.

Specifically, as indicated in the HTTP documentation source, the request->method object is a FIOBJ object.

This means that all the FIOBJ functions are available, such as the fiobj_obj2cstr function (which will be replaced in the 0.8 version with the fiobj2cstr function.

For the body object, I would recommend reading the data a slice at a time (unless you know it's length is small enough). The type is a FIOBJ_T_DATA (fiobj_data), which allows the data to be stored in a temporary file when it makes sense to do so.

boazsegev avatar Dec 04 '19 11:12 boazsegev

Thank you for your honest feedback I think document
shows a basic example of how this would be used.such as PHP language of laravel framework,there are many usage example

immortalChensm avatar Dec 05 '19 01:12 immortalChensm