Главная Обзор Помощь
Регистрация Вход
wangjunyun
/
scribe
зеркало из https://github.com/knuckleswtf/scribe.git
1
0
Ответвить 0
Файлы Задачи 0 Вики

Scribe可以帮助您自动生成文档，但是如果您真的想制作友好，可维护和可测试的API文档，则还需要了解更多信息。所以我为你做了一门课程。🤗

Дерево: cb4c2e552f
Ветки Метки
scribe
ZIP TAR.GZ
Shalvah cb4c2e552f 4.39.0 4 месяцев назад
.github e41b0d75ea Adjust CI 1 год назад
camel a6aee1d561 feat: add required to responseField tag and append the required fields to generateResponseContentSpec for object types (#814) 6 месяцев назад
config f00f6bffa7 Update scribe.php (#928) 4 месяцев назад
lang 7ad83bc02c Adjust indentation 1 год назад
resources a26d9c912a render laravel dd() dump output properly (#893) 7 месяцев назад
routes 92c128171c Final cleanups 2 лет назад
src cb4c2e552f 4.39.0 4 месяцев назад
tests 46e8399edd Cursor pagination support (#917) 5 месяцев назад
.editorconfig c897db868e fix(.editorconfig): added formatter for .json files 3 лет назад
.gitattributes c3a31009ba Support spatie/dto 3 3 лет назад
.gitignore ac9404ac12 Add tests for laravel type 2 лет назад
CHANGELOG.md cb4c2e552f 4.39.0 4 месяцев назад
CONTRIBUTING.md af8384feaf Update contribution guide link (#805) 1 год назад
Dockerfile 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) 1 год назад
LICENSE.md 561dac8003 Refactor 2 лет назад
Makefile 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) 1 год назад
README.md cb258f6e91 Update/fix migration URL in README. Remove errant backtick (#785) 1 год назад
composer.dingo.json 266326f05e Support php-parser v5 1 год назад
composer.json 138a47bed7 feat: Add Laravel 11 Support (#812) 1 год назад
composer.lowest.json 266326f05e Support php-parser v5 1 год назад
docker-compose.yml 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) 1 год назад
logo-scribe.png 908fd36b04 Update doc 5 лет назад
phpstan.neon 39f57d875b Fix lint 1 год назад
phpunit.xml 57b55ec1ce Support matching routes on method + path 1 год назад

README.md

Scribe

Latest Stable Version Total Downloads


v4 is out now! Featuring subgroups, easier sorting, and an automated upgrade command.

Scribe helps you generate API documentation for humans from your Laravel/Lumen/Dingo codebase. See a live example at demo.scribe.knuckles.wtf.

Features

  • 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 for you.🤗

Documentation

Check out the documentation at scribe.knuckles.wtf/laravel.

If you're coming from mpociot/laravel-apidoc-generator, first migrate to v3, then to v4.

Contributing

Contributing is easy! See our contribution guide.