Startseite Erkunden Hilfe
Registrieren Anmelden
wangjunyun
/
scribe
Mirror von https://github.com/knuckleswtf/scribe.git
1
0
Fork 0
Dateien Issues 0 Wiki

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

Struktur: 4.34.0
Branches Tags
scribe
ZIP TAR.GZ
Shalvah 30624433a3 4.34.0 vor 1 Jahr
.github e41b0d75ea Adjust CI vor 1 Jahr
camel fea04b1afe Fix tests vor 1 Jahr
config a04d1773c3 External UI improvements (#780) vor 1 Jahr
lang 7ad83bc02c Adjust indentation vor 1 Jahr
resources e8ac03d04e fix Fixed page sidebar style error when 'type' is' External_Static','theme' is' Elements' (#820) vor 1 Jahr
routes 92c128171c Final cleanups vor 2 Jahren
src 30624433a3 4.34.0 vor 1 Jahr
tests efd6f6ce18 Auto-migrate old route rules to new settings vor 1 Jahr
.editorconfig c897db868e fix(.editorconfig): added formatter for .json files vor 3 Jahren
.gitattributes c3a31009ba Support spatie/dto 3 vor 3 Jahren
.gitignore ac9404ac12 Add tests for laravel type vor 2 Jahren
CHANGELOG.md 30624433a3 4.34.0 vor 1 Jahr
CONTRIBUTING.md af8384feaf Update contribution guide link (#805) vor 1 Jahr
Dockerfile 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) vor 1 Jahr
LICENSE.md 561dac8003 Refactor vor 2 Jahren
Makefile 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) vor 1 Jahr
README.md cb258f6e91 Update/fix migration URL in README. Remove errant backtick (#785) vor 1 Jahr
composer.dingo.json 266326f05e Support php-parser v5 vor 1 Jahr
composer.json 138a47bed7 feat: Add Laravel 11 Support (#812) vor 1 Jahr
composer.lowest.json 266326f05e Support php-parser v5 vor 1 Jahr
docker-compose.yml 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) vor 1 Jahr
logo-scribe.png 908fd36b04 Update doc vor 5 Jahren
phpstan.neon 39f57d875b Fix lint vor 1 Jahr
phpunit.xml 57b55ec1ce Support matching routes on method + path vor 1 Jahr

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.