Skip to content

Joomla component to offer a simple (REST-like) API

License

Notifications You must be signed in to change notification settings

DipityBV/pkg_api

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 

Repository files navigation

API component for Joomla

With this component, you can serve JSON API feeds from simple calls. Each request is confirming to the following format:

http://JOOMLA/ENTRY_POINT/COMPONENT/MODEL/1

The ENTRY_POINT is a Menu-Item that you create yourself and is appoint to the component. The COMPONENT is the component name - equal to option but without the com_ part. The MODEL is the name of the model.

For instance, the following URL outputs the output of com_content its articles model (ContentModelArticles) using the method getItems().

http://localhost/joomla1/index.php/api/content/articles/

For singular items, the method getItem() could be used. If alternative methods, or alternative model-names are used, you will need to include an api.php file within your own component. See the components/com_content/api.php file in this repo for a dummy.

Fun stuff

A single article:

http://localhost/joomla1/index.php/api/content/articles/42

Get a list of users (if logged in as an admin user):

http://localhost/joomla1/index.php/api/users/users

Finder search:

http://localhost/joomla1/index.php/api/finder/suggestions?q=t

About

Joomla component to offer a simple (REST-like) API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 100.0%