PHPackages                             jobins/api-generator - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Testing & Quality](/categories/testing)
4. /
5. jobins/api-generator

ActiveLibrary[Testing & Quality](/categories/testing)

jobins/api-generator
====================

Generate api docs while writing test case (Laravel).

v0.0.9(3y ago)79.4k↓44%3[7 issues](https://github.com/JoBinsJP/api-generator/issues)MITPHPPHP ^7.4|^8.0|^8.1

Since Apr 15Pushed 3y ago4 watchersCompare

[ Source](https://github.com/JoBinsJP/api-generator)[ Packagist](https://packagist.org/packages/jobins/api-generator)[ Docs](https://github.com/JoBinsJP/api-genereator)[ RSS](/packages/jobins-api-generator/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (8)Dependencies (3)Versions (9)Used By (0)

API Generator
=============

[](#api-generator)

Generate api docs while writing test case (Laravel).

### Idea

[](#idea)

It generates api docs with [OpenAPI Specification](https://swagger.io/specification) while wiring test case in laravel application. The generated docs can preview on swagger ui either integrate laravel-swagger-ui on application or [Swagger Editor online](https://editor.swagger.io/).

##### Features

[](#features)

- All basic setup features as available in swagger api.
- Request body will define using Laravel FormRequest class.
- The Request body example will grab from test data that used on testing.
- Route parameters will define from Laravel route.
- Response example grabs from the test responses.

### Installation

[](#installation)

```
composer require jobins/api-generator --dev
```

### Publish assets

[](#publish--assets)

```
php artisan vendor:publish --provider="Jobins\APIGenerator\APIGeneratorServiceProvider"
```

### Basic Uses

[](#basic-uses)

```