https://github.com/larecipe/larecipe-swagger

Live API Testing Inside Your Documentation
https://github.com/larecipe/larecipe-swagger

Last synced: 8 days ago
JSON representation

Live API Testing Inside Your Documentation

• Host: GitHub
• URL: https://github.com/larecipe/larecipe-swagger
• Owner: larecipe
• License: mit
• Created: 2019-07-23T07:24:23.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-09-19T01:01:31.000Z (about 2 years ago)
• Last Synced: 2024-11-01T20:38:18.200Z (11 days ago)
• Language: Vue
• Homepage: https://larecipe.binarytorch.com.my
• Size: 33.2 KB
• Stars: 34
• Watchers: 5
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

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](https://larecipe.saleem.dev/images/packages/swagger.png#)

## Getting Started

1. Install the package via composer.

```bash

composer require binarytorch/larecipe-swagger

```

2. Use the provided VueJs component:

```html

```

3. Test your API:

![LaRecipe Screenshot](https://larecipe.saleem.dev/images/packages/swagger-screenshot.png)

3. 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](https://larecipe.saleem.dev/docs)

## License

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