You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- <imgsrc="https://global-uploads.webflow.com/5ea1b599e88dc9edc465e8f5/5ea8b30dd43a0b44bbc91bd8_favicon-32x32.png"height="17"> **Optic:**`npm install -g @useoptic/cli` (needed for automatic documentation)
75
77
76
78
**Note:** If you are new to Laravel, I recommend to watch
77
79
[Laravel From Scratch](https://laracasts.com/series/laravel-5-from-scratch) screencast by Jeffery Way that teaches Laravel 5 from scratch. Alternatively,
-[laravel-emoji](https://github.com/unicodeveloper/laravel-emoji) - For using emojis in your app
436
438
-[laravel-quotes](https://github.com/unicodeveloper/laravel-quotes) - For using all sorts of quotes especially DJKHALED in your app
437
439
440
+
Enabling Automatic Documentation
441
+
-----------------------------
442
+
Using [Optic](https://github.com/opticdev/optic), you can use your API like normal, automatically documenting changes in behavior. To enable this, you'll first need to download Optic.
443
+
444
+
```bash
445
+
npm install -g @useoptic/cli
446
+
```
447
+
448
+
Once you've installed Optic, you can start documenting your requests by running `api start`. Running this command will create a proxied version of your api, available at [localhost:4000](http://localhost:4000) - now, you can use the API like normal here, and Optic will automatically notice differences in the documented behavior, allowing you to automatically create documentation as your API changes.
449
+
450
+
To view the current documentation of the api, run `api spec` at the root directory.
451
+
452
+
#### Useful Commands
453
+
454
+
```bash
455
+
api start # use this to start monitoring your API
456
+
api spec # use this to inspect the current documentation of your API
457
+
api generate:oas # generates an OpenAPI specification for your currently documented API
458
+
```
459
+
460
+
For more information about Optic, [check out the docs](https://docs.useoptic.com).
0 commit comments