From c793b27deb858c798e37cfb336b12f83dfb509c8 Mon Sep 17 00:00:00 2001 From: Konstantin Lapkovsky Date: Tue, 19 Dec 2023 13:16:07 +0400 Subject: [PATCH 1/2] docs: add documentation block with comparison to another documentation generators. --- readme.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/readme.md b/readme.md index 6d3b022..d9c7402 100644 --- a/readme.md +++ b/readme.md @@ -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 | +|-|-|-| +| Force developers to write tests | + | - | +| Guarantee that API works | + | - | +| Integrate without routes modification | + | - | +| Generate response schema without using JSON Resource class | + | - | +| Need a sorage to save generated documentation | + | - | + ## Introduction This plugin is designed to generate documentation for your REST API during the From 2c8e02abcc633f0a05715d26536f2dd0980123e5 Mon Sep 17 00:00:00 2001 From: Konstantin Lapkovsky Date: Wed, 20 Dec 2023 13:51:54 +0400 Subject: [PATCH 2/2] docs: correct comparison block. --- readme.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/readme.md b/readme.md index d9c7402..19f2848 100644 --- a/readme.md +++ b/readme.md @@ -13,13 +13,13 @@ ## Comparison to another documentation generators -| | LaravelSwagger | Scramble | -|-|-|-| -| Force developers to write tests | + | - | -| Guarantee that API works | + | - | -| Integrate without routes modification | + | - | -| Generate response schema without using JSON Resource class | + | - | -| Need a sorage to save generated documentation | + | - | +| | 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