https://github.com/knuckleswtf/thesideprojectapi
Demo API to demonstrate Scribe's capabilities
https://github.com/knuckleswtf/thesideprojectapi
documentation
Last synced: about 1 year ago
JSON representation
Demo API to demonstrate Scribe's capabilities
- Host: GitHub
- URL: https://github.com/knuckleswtf/thesideprojectapi
- Owner: knuckleswtf
- Created: 2021-05-30T00:36:30.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-25T20:49:30.000Z (over 2 years ago)
- Last Synced: 2025-04-19T20:53:34.663Z (about 1 year ago)
- Topics: documentation
- Language: Blade
- Homepage: http://demo.scribe.knuckles.wtf
- Size: 562 KB
- Stars: 3
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# The SideProject API
Sample Laravel API to demonstrate [Scribe's](http://scribe.knuckles.wtf) API documentation capabilities. See the docs at [demo.scribe.knuckles.wtf](http://demo.scribe.knuckles.wtf).
To generate the main docs, run `php artisan scribe:generate`. Docs will be generated to the `docs/` folder, so you can simply open `docs/index.html` in your browser.
There's also a second set of docs, to test Scribe's multi-docs' feature. This uses the config file `config/scribe-alternate.php`, so the command is `php artisan scribe:generate --config scribe-alternate`. They use `laravel` type, so will be accessible at `/alternate/docs` when you start the server.