binarytorch/larecipe-swagger

Live API Testing Inside Your Documentation

Maintainers

Details

github.com/saleem-hadad/larecipe-swagger

Source

Issues

Fund package maintenance!
saleem-hadad

Installs: 45 943

Dependents: 2

Suggesters: 0

Security: 0

Stars: 34

Watchers: 5

Forks: 4

Language:Vue

v0.2 2019-07-24 13:08 UTC

Requires

  • php: >=7.1.0

MIT 3d3e7542a8f751538bb1011729fded75aa81f65c

laravellarecipe

This package is auto-updated.

Last update: 2025-03-01 00:28:01 UTC

README

LaRecipe Swagger

Let your users tests your APIs directly from the documentation!

LaRecipe 🍪

LaRecipe is simply a code-driven package provides an easy way to create beautiful documentation for your product or application inside your Laravel app.

LaRecipe Screenshot

Getting Started

  1. Install the package via composer.
composer require binarytorch/larecipe-swagger
  1. Use the provided VueJs component:
<larecipe-swagger endpoint="/api/v1/users"></larecipe-swagger>
  1. Test your API:

LaRecipe Screenshot

  1. Customize your component via props:
Prop Type Default Example
base-url String The current location origin https://example.com
endpoint String - /api/v1/users
default-headers Object - { 'Content-Type': 'application/json' }
default-params Object - { 'name': 'saleem' }
default-method String get get,post,put,patch,update,delete
has-common-headers Boolean false { 'Content-Type': 'application/json', 'Accept': 'application/json' }
has-auth-header Boolean false { 'Authorization': 'Bearer token_here' }

See full larecipe documentation

License

This library is licensed under the MIT License - see the LICENSE.md file for details.