Git Product home page Git Product logo

codeigniter-apidocs's Introduction

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

codeigniter-apidocs's People

Contributors

kawoou avatar owen1025 avatar toori67 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.