Skip to content
Thomas Threadgold edited this page Mar 19, 2020 · 12 revisions

Documentation

NOTE: To locate all documentation regarding the plugin, please refer to the docs folder which can be found in the code repository.

Specification

Here you can find specification on all the endpoints provided by the API:

You can also view the specification in SwaggerUI, which you may find easier to read than the specification file itself.

Plugin configuration

The API plugin allows for substantial configuration, such as enabling/disabling endpoints and methods, toggling authentication, response filtering, etc.

Please refer to the docs/CONFIGURATION.md file for specific information on how to set up the plugin on your Grav installation.

Authentication

Some endpoints require authorisation in order to be used. There is currently a Basic authentication type implemented.

Please refer to the docs/AUTHENTICATION.md file for more information regarding available roles, configuring user accounts, and how to authorise API requests.

Development

If you wish to contribute to the development of the API plugin, please consult the docs/DEVELOPMENT.md file to learn more about the development environment setup and procedures.

You can refer to the project board to see which issues are prioritised for development.

Clone this wiki locally