Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add documentation block with comparison to another generators #117

Merged
merged 2 commits into from
Dec 20, 2023
Merged

docs: add documentation block with comparison to another generators #117

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c793b27
docs: add documentation block with comparison to another documentatio…
Dec 19, 2023
2c8e02a
docs: correct comparison block.
Dec 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,16 @@
[![Laravel Swagger](https://github.com/RonasIT/laravel-swagger/actions/workflows/laravel.yml/badge.svg?branch=master)](https://github.com/RonasIT/laravel-swagger/actions/workflows/laravel.yml)
[![Coverage Status](https://coveralls.io/repos/github/RonasIT/laravel-swagger/badge.svg?branch=master)](https://coveralls.io/github/RonasIT/laravel-swagger?branch=master)

## Comparison to another documentation generators

| | LaravelSwagger | [Scramble](https://github.com/dedoc/scramble) |
|-|------------------------|----------------------------------------------|
| Force developers to write tests | :white_check_mark: | :x: |
| Guarantee that API works | :white_check_mark: | :x: |
| Integrate without routes modification | :white_check_mark: | :x: |
| Generate response schema using JSON Resource class | :x: | :white_check_mark: |
| Runtime documentation generation | :x: | :white_check_mark: |

## Introduction

This plugin is designed to generate documentation for your REST API during the
Expand Down