|
|
@@ -1,30 +1,33 @@
|
|
|
-# Documentarian
|
|
|
-#### Simply write beautiful API documentation.
|
|
|
-========
|
|
|
+## Laravel API Documentation Generator (WIP)
|
|
|
|
|
|
-This project is a PHP port of the popular [Slate](https://github.com/tripit/slate) API documentation tool.
|
|
|
+`php artisan api:gen --routePrefix=settings/api/*`
|
|
|
|
|
|
-> If PHP is not your thing and you're more into nodeJS, why not give [Whiteboard](https://github.com/mpociot/whiteboard) a try?
|
|
|
|
|
|
-<a href="http://www.marcelpociot.com/whiteboard/"><img src="http://www.marcelpociot.com/git/whiteboard_responsive.jpg" style="width: 100%" alt="Documentarian" /></a>
|
|
|
+### Install
|
|
|
|
|
|
-Check out a Documentarian [example API documentation](http://www.marcelpociot.com/whiteboard/).
|
|
|
+Require this package with composer using the following command:
|
|
|
|
|
|
-The documentation is available at [http://marcelpociot.com/documentarian/installation](http://marcelpociot.com/documentarian/installation)
|
|
|
+```bash
|
|
|
+composer require mpociot/laravel-apidoc-generator
|
|
|
+```
|
|
|
+Go to your `config/app.php` and add the service provider:
|
|
|
|
|
|
+```php
|
|
|
+Mpociot\ApiDoc\ApiDocGeneratorServiceProvider::class
|
|
|
+```
|
|
|
|
|
|
-### Slate / Whiteboard compatibility
|
|
|
-Since both Documentarian and Slate use regular markdown files to render the API documentation, your existing Slate API documentation should work just fine. If you encounter any issues, please [submit an issue](https://github.com/mpociot/documentarian/issues).
|
|
|
+### Usage
|
|
|
|
|
|
-### In depth documentation
|
|
|
-For further documentation, read the [Slate Wiki](https://github.com/tripit/slate/wiki).
|
|
|
|
|
|
-### Documentations built with Documentarian
|
|
|
+```
|
|
|
+php artisan api:generate
|
|
|
+ {--output=public/docs : The output path for the generated documentation}
|
|
|
+ {--routePrefix= : The route prefix to use for generation - * can be used as a wildcard}
|
|
|
+ {--routes=* : The route names to use for generation - if no routePrefix is provided}
|
|
|
+ {--actAsUserId= : The user ID to use for API response calls}
|
|
|
+```
|
|
|
|
|
|
-Feel free to submit a PR with a link to your documentation.
|
|
|
|
|
|
-### Contributors
|
|
|
+### License
|
|
|
|
|
|
-Slate was built by [Robert Lord](https://lord.io) while at [TripIt](http://tripit.com).
|
|
|
-
|
|
|
-Documentarian was built by Marcel Pociot.
|
|
|
+The Laravel API Documentation Generator is free software licensed under the MIT license.
|
Marcel Pociot