laravel-redoc

KO | EN

gitlite — search

#python #javascript #golang #css #java #go #typescript #html #fastapi #github #unity #simulation

★ 92 Open GitHub ↗

A simple API documentation package for Laravel using OpenAPI and Redoc

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Laravel Redoc

[![Latest Version on Packagist][ico-version]][link-packagist]
[![Software License][ico-license]](https://raw.githubusercontent.com/JustSteveKing/laravel-redoc/main/LICENSE.md)
[![Build Status][ico-github-action]][link-github-action]
[![Total Downloads][ico-downloads]][link-downloads]

Easily publish your API documentation using your OpenAPI document in your Laravel Application.

## Installation

You can install this package via composer:

```bash
composer require juststeveking/laravel-redoc
```

## Enabling Alfred

To enable Alfred on your docs, visit: https://www.treblle.com/product/alfred or https://docs.treblle.com/treblle/ai-assistant

## Configuration

You can publish the configuration file with:

```bash
php artisan vendor:publish --provider="JustSteveKing\Laravel\LaravelRedoc\RedocServiceProvider" --tag="config"
```

This is the contents of the published config file:

```php
return [
    'path' => [
        'name' => env('REDOC_PATH_NAME', 'docs'),
        'url' => env('REDOC_PATH_URL', 'api/docs'),
    ],
    
    'alfred' => [
        'enabled' => env('REDOC_ALFRED', true),
        'project_id' => env('ALFRED_PROJECT_ID', null),
        'api_key' => env('ALFRED_API_KEY', null),
    ],

'openapi' => [
        'path' => env('REDOC_OPENAPI_PATH', 'http://petstore.swagger.io/v2/swagger.json')
    ],

'config' => [
        'search' => false,

'hostname' => false,

'loading' => false,

'menu' => true,

'scrollbars' => true,

'trust' => true,
    ]
];
```

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details.

## Security

If you discover any security related issues, please email juststevemcd@gmail.com instead of using the issue tracker.

## Credits

- [Steve McDougall][link-author]
- [All Contributors][link-contributors]
- [Redocly Team for their open source tool redoc](https://github.com/Redocly/redoc)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

[ico-version]: https://img.shields.io/packagist/v/juststeveking/laravel-redoc.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-github-action]: https://github.com/JustSteveKing/laravel-redoc/workflows/run-tests/badge.svg?branch=main
[ico-downloads]: https://img.shields.io/packagist/dt/juststeveking/laravel-redoc.svg?style=flat-square

[link-packagist]: https://packagist.org/packages/juststeveking/laravel-redoc
[link-github-action]: https://github.com/JustSteveKing/laravel-redoc/actions
[link-downloads]: https://packagist.org/packages/juststeveking/laravel-redoc
[link-author]: https://github.com/JustSteveKing
[link-contributors]: ../../contributors

laravel-redoc

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README