chriskacerguis / codeigniter-restserver

A fully RESTful server implementation for CodeIgniter using one library, one config file and one controller.
MIT License
4.89k stars 2.86k forks source link

Documentation #1108

Closed oncloudatencion closed 3 years ago

oncloudatencion commented 4 years ago

Hi, i'm looking for documentation, some body can help me?

alfinforwork commented 4 years ago

In readme

DoWebMx commented 4 years ago

In readme

Thanks man, but the readme file don't content any information about auth method, just include a basic example for use.

Kunwark commented 4 years ago

I am reading the readme.md but I can't make sense of how the URLs work and how are they mapped with the functions?

Kunwark commented 4 years ago

users_get() function works and it gets me the data as well but even when I change the function name it stops working. How are these functions mapped? I created users_post but that won't work... How do we get this API to work properly?

kunwarkhalid commented 4 years ago

@chriskacerguis Is there a more detailed documentation somewhere?

Bliksempie commented 4 years ago

I am willing to make [some] documentation for this (it could definitely be a collaborative issue) - busy with a new project for myself, and having to figure a few things out for myself. What is the preferred documentation platform? Markdown within this repo? Or do you prefer something like Sphynx/readthedocs?

Bliksempie commented 4 years ago

I am reading the readme.md but I can't make sense of how the URLs work and how are they mapped with the functions?

The URLs are standard CodeIgniter URI segments, I think. RestServer does not introduce new things over and above the way CodeIgniter does this.

kunwarkhalid commented 4 years ago

I have started to get a hold of this framework. I am willing to contribute to the documentation as well. @Bliksempie let me know if you would like to collaborate on this. I think Chris has used markdown and we can continue improving the same one.

josemilioz commented 4 years ago

Hello guys. Just found this old implementation that you can use as an example for a more complete documentation on this version of the rest server: https://github.com/ricsunny/ciAuth. It uses the old version but you'll have the clue. Good luck!

github-actions[bot] commented 3 years ago

Stale issue message