Skip to content

owen1025/codeigniter-apidocs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

93 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Codeigniter-apidocs

Parsing Codeigniter project's controller and make api documents. Also provide Request Form and Response Form for api testing.

Feature

  • Restful api request support
  • JSON/ XML response format support

Support

Installation

Download codeigniter-apidocs.zip or git clone. Drag and drop the controller/Docs.php and views/docs.html files into your application's directories. Very simply installation!

Usage

Connect to base_url/your_project/index.php/docs or base_url/your_project/docs

Screenshot

alt tag

Description designation method

  • Once insert /* @Description <description_content> */ at api code, Api form will apper.

For example

public function api_test(){
	/*
		@Description This is description 
	*/
	echo "API TEST";
}

will show below

alt tag

License

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published