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

shalvah 4cf022bd88 4.21.0 преди 2 години
.github 8237b0df6a Create config.yml преди 2 години
camel 8fe91d86e6 Expose default strategy for URL normalization преди 2 години
config 8183c296b5 Fix typo преди 2 години
lang 7ad83bc02c Adjust indentation преди 2 години
resources 392b1094d7 Implement custom translation layer преди 2 години
routes 92c128171c Final cleanups преди 2 години
src ce98875b94 Raise error if translation not found преди 2 години
tests f0ed95653b API resources: Infer model name from @mixin преди 2 години
.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 години
.travis.yml c91eed5499 Update CI преди 3 години
CHANGELOG.md 4cf022bd88 4.21.0 преди 2 години
CONTRIBUTING.md 6457ea46f4 Add contribution guide преди 5 години
LICENSE.md 561dac8003 Refactor преди 2 години
README.md 3328b3d2dd Readme преди 2 години
composer.dingo.json 23a6583667 Refactor преди 2 години
composer.json f0ed95653b API resources: Infer model name from @mixin преди 2 години
composer.lowest.json 3ea1bc647f Dingo and lowest deps преди 2 години
logo-scribe.png 908fd36b04 Update doc преди 5 години
phpstan.neon 9a02fdb91b Fix build преди 2 години
phpunit.xml ecfd1a18e5 Fix nested filters when generating examples for PHP, JS and Python преди 2 години

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.