Skip to content

Commit

Permalink
Merge pull request #117 from RonasIT/extend-readme-with-comparison
Browse files Browse the repository at this point in the history
docs: add documentation block with comparison to another generators
  • Loading branch information
DenTray authored Dec 20, 2023
2 parents e939c8f + 2c8e02a commit e39de87
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions readme.md
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

0 comments on commit e39de87

Please sign in to comment.