Skip to content
Laravel Dredd OpenApi v3 Example
PHP HTML Other
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
bin Update docs test Feb 25, 2019
bootstrap Initial commit Feb 24, 2019
config Initial commit Feb 24, 2019
database Add posts Feb 24, 2019
documentation/v1 Add posts endpoint with assertion for array Mar 7, 2019
public Initial commit Feb 24, 2019
resources Initial commit Feb 24, 2019
routes Add posts endpoint with assertion for array Mar 7, 2019
storage Initial commit Feb 24, 2019
tests Add posts endpoint with assertion for array Mar 7, 2019
.editorconfig Initial commit Feb 24, 2019
.env.example Add posts Feb 24, 2019
.gitattributes
.gitignore Update docs and add redoc serve Feb 24, 2019
artisan Initial commit Feb 24, 2019
composer.json Dredd tests running Feb 25, 2019
composer.lock Add docs test Feb 24, 2019
package.json Update docs and add redoc serve Feb 24, 2019
phpunit.xml Initial commit Feb 24, 2019
readme.md Update docs Feb 25, 2019
server.php Initial commit Feb 24, 2019
webpack.mix.js Initial commit Feb 24, 2019

readme.md

Laravel Dredd OpenAPI v3 Documentation Verification

Install Dependencies

  • composer install
  • npm install

Verify the docs

  • Migrate the db (SQLITE): php artisan migrate
  • Serve the test site: php artisan serve
  • Verify and build the docs using Dredd: ./bin/docs-test.sh

Docs

Docs built using Redoc

  • npm install --production=false
  • ./node_modules/.bin/redoc-cli serve documentation/v1/swagger_v2.json

View docs at http://127.0.0.1:8080

You can’t perform that action at this time.