Skip to content

tanmayk/boot_api

Repository files navigation

✨ Boot API ✨

Free & easy way to document your APIs.

Boot API is provides an easy & free way to document your APIs. The idea was to create free & open source solution for API documentation.

Report a Bug · Request a Feature · Ask a Question

license made with love by OSSeed

Feel free to try this out. I am open to suggestions. See how it looks.

How To

  • Checkout the code & update the config.php file for below details:

Title: The title of your project.

Version: Version of your API document.

Base URL: Base URL of your API service.

  • Add machine name of your API endpoint in apis.php.
  • Create a php file under modules with same machine name as per api.php. E.g. If you added example as machine name, you must create example.php in modules directory.
  • The php file must have functions as below:

example_endpoint() - This function provides an information about your API.

example_request() - This function provides an information about request parameters for your API.

example_response() - This function provides an information about response parameters for your API. There can be multiple responses for any HTTP code.

  • Refer search_drink.php under modules directory for more details about code.

License

MIT

Free Software, Hell Yeah!

About

Free & easy way to document your APIs.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published