Automated API Documentation with Scramble

Scramble, integrated into our Laravel project, offers a streamlined approach to generating API documentation effortlessly. This Laravel package eliminates manual effort, simplifying the documentation process for developers.

Accessing the Documentation

After integrating Scramble into your Laravel application, two routes are automatically available:

• /docs/api: This route presents a user-friendly UI for browsing your API documentation.
• /docs/api.json: Access the OpenAPI document in JSON format, outlining your API endpoints.

To access your documentation, simply navigate to /docs/api using your web browser.

Integrating with Postman or Insomnia

Seamlessly integrating your API documentation with tools like Postman or Insomnia is straightforward with Scramble:

1. Export Documentation: Visit /docs/api and locate the option to export the documentation. Choose either JSON or YAML format.

2. Save the Exported File: Download and save the exported file to your local system.

3. Import into Postman:

   • Launch Postman, click on "Import," and select the exported JSON or YAML file.

4. Import into Insomnia:

   • In Insomnia, navigate to the "Import/Export" section and opt to import a file. Choose the exported JSON or YAML file.