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

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

ИН на ревизия: ed7d87b14f
Клонове Маркери
scribe
ZIP TAR.GZ
Shalvah ed7d87b14f Simplify old config file преди 1 година
.github e41b0d75ea Adjust CI преди 1 година
camel fea04b1afe Fix tests преди 1 година
config ed7d87b14f Simplify old config file преди 1 година
lang 7ad83bc02c Adjust indentation преди 2 години
resources 90d86bcc30 Update nested-fields.blade.php (#759) преди 1 година
routes 92c128171c Final cleanups преди 2 години
src ed7d87b14f Simplify old config file преди 1 година
tests efd6f6ce18 Auto-migrate old route rules to new settings преди 1 година
.editorconfig c897db868e fix(.editorconfig): added formatter for .json files преди 3 години
.gitattributes c3a31009ba Support spatie/dto 3 преди 3 години
.gitignore ac9404ac12 Add tests for laravel type преди 3 години
.travis.yml c91eed5499 Update CI преди 4 години
CHANGELOG.md a1ecc46006 WIP: Upgrade story преди 1 година
CONTRIBUTING.md 6457ea46f4 Add contribution guide преди 5 години
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 47b77b2018 Fix course link преди 1 година
composer.dingo.json e74a33b839 Allow Symfony v7 components преди 1 година
composer.json e74a33b839 Allow Symfony v7 components преди 1 година
composer.lowest.json 7060e7fdd6 Adjust CI (test) преди 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 преди 2 години
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.