Skip to content

Commit 2ce537f

Browse files
committed
update docs
1 parent 587fba9 commit 2ce537f

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Automatically generate your API documentation from your existing Laravel routes.
1717
Require this package with composer using the following command:
1818

1919
```sh
20-
$ composer require oxycoder/laravel-apidoc-generator
20+
composer require oxycoder/laravel-apidoc-generator
2121
```
2222
Using Laravel < 5.5? Go to your `config/app.php` and add the service provider:
2323

@@ -32,7 +32,7 @@ Oxycoder\ApiDoc\ApiDocGeneratorServiceProvider::class,
3232
To generate your API documentation, use the `api:generate` artisan command.
3333

3434
```sh
35-
$ php artisan api:generate --routePrefix="api/v1/*"
35+
php artisan api:generate --routePrefix="api/v1/*"
3636
```
3737

3838
This command will scan your applications routes for the URIs matching `api/v1/*` and will parse these controller methods and form requests. For example:
@@ -70,7 +70,7 @@ Option | Description
7070
By default, this package returns the descriptions in english. You can publish the packages language files, to customise and translate the documentation output.
7171

7272
```sh
73-
$ php artisan vendor:publish
73+
php artisan vendor:publish
7474
```
7575

7676
After the files are published you can customise view, styles or translate the descriptions in the language you want by renaming the `en` folder and editing the files in `public/vendor/apidoc/resources/lang`.
@@ -199,13 +199,13 @@ If your API route accepts a `GET` method, this package tries to call the API rou
199199
If your API needs an authenticated user, you can use the `actAsUserId` option to specify a user ID that will be used for making these API calls:
200200

201201
```sh
202-
$ php artisan api:generate --routePrefix="api/*" --actAsUserId=1
202+
php artisan api:generate --routePrefix="api/*" --actAsUserId=1
203203
```
204204

205205
If you don't want to automatically perform API response calls, use the `noResponseCalls` option.
206206

207207
```sh
208-
$ php artisan api:generate --routePrefix="api/*" --noResponseCalls
208+
php artisan api:generate --routePrefix="api/*" --noResponseCalls
209209
```
210210

211211
> Note: The example API responses work best with seeded data.
@@ -236,7 +236,7 @@ The default location of this file is: `public/docs/source/index.md`.
236236
After editing the markdown file, use the `api:update` command to rebuild your documentation as a static HTML file.
237237

238238
```sh
239-
$ php artisan api:update
239+
php artisan api:update
240240
```
241241

242242
As an optional parameter, you can use `--location` to tell the update command where your documentation can be found.

0 commit comments

Comments
 (0)