From 3328b3d2ddc9ae6d8b271e10c7d1dd27326235d5 Mon Sep 17 00:00:00 2001 From: shalvah Date: Fri, 28 Apr 2023 12:52:45 +0200 Subject: [PATCH] Readme --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 40f4694b..699e9581 100644 --- a/README.md +++ b/README.md @@ -12,14 +12,17 @@ Scribe helps you generate API documentation for humans from your Laravel/Lumen/[Dingo](https://github.com/dingo/api) codebase. See a live example at [demo.scribe.knuckles.wtf](https://demo.scribe.knuckles.wtf). ## Features -- Pretty single-page HTML doc, with human-friendly text, code samples, and included in-browser API tester ("Try It Out") -- Extracts body parameters details from FormRequests or validation rules -- Safely calls API endpoints to get sample responses -- Supports generating responses from Transformers or Eloquent API Resources -- Generates Postman collection and OpenAPI spec -- Easily customisable with custom views and included UI components -- Easily extensible with custom strategies -- Statically define extra endpoints that aren't in your codebase +- Useful output: + - Pretty single-page HTML doc, with human-friendly text, code samples, and in-browser API tester ("Try It Out") + - Generates Postman collection and OpenAPI spec +- Smarts. Scribe can: + - extract request parameter details from FormRequests or validation rules + - safely call API endpoints to get sample responses + - generate sample responses from Eloquent API Resources or Transformers +- Customisable to different levels: + - Customise the UI by adjusting text, ordering, examples, or change the UI itself + - Add custom strategies to adjust how data is extracted + - Statically define extra endpoints or information that isn't in your codebase > 👋 Scribe helps you generate docs automatically, but if you really want to make friendly, maintainable and testable API docs, there's some more things you need to know. So I made [a course](https://apidocsfordevs.com?utm_source=scribe-laravel&utm_medium=referral&utm_campaign=none) for you.🤗