binarytorch/larecipe-swagger

Live API Testing Inside Your Documentation

Fund package maintenance!
Open Collective

Installs: 5 540

Dependents: 1

Suggesters: 0

Security: 0

Stars: 30

Watchers: 6

Forks: 2

Language:Vue

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

This package is auto-updated.

Last update: 2020-08-31 00:46:26 UTC


README

68747470733a2f2f6c617265636970652e62696e617279746f7263682e636f6d2e6d792f696d616765732f6c6f676f2e737667

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.