Halaman utama Jelajahi Bantuan
Daftar Masuk
wangjunyun
/
scribe
cermin dari https://github.com/knuckleswtf/scribe.git
1
0
Fork 0
Berkas Masalah 0 Wiki

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

Pohon: 4.35.0
Ranting Tag
scribe
ZIP TAR.GZ
Shalvah dd66966769 4.35.0 1 tahun lalu
.github e41b0d75ea Adjust CI 1 tahun lalu
camel 88b6c67c49 Allow examples to be shown in response fields (#825) 1 tahun lalu
config a04d1773c3 External UI improvements (#780) 1 tahun lalu
lang 7ad83bc02c Adjust indentation 1 tahun lalu
resources 84e49b5457 added cast number value to float if value is string (#830) 1 tahun lalu
routes 92c128171c Final cleanups 2 tahun lalu
src dd66966769 4.35.0 1 tahun lalu
tests 90caff1f83 Fix translating rules with translation engines that don't return arrays. (#826) 1 tahun lalu
.editorconfig c897db868e fix(.editorconfig): added formatter for .json files 3 tahun lalu
.gitattributes c3a31009ba Support spatie/dto 3 3 tahun lalu
.gitignore ac9404ac12 Add tests for laravel type 2 tahun lalu
CHANGELOG.md dd66966769 4.35.0 1 tahun lalu
CONTRIBUTING.md af8384feaf Update contribution guide link (#805) 1 tahun lalu
Dockerfile 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) 1 tahun lalu
LICENSE.md 561dac8003 Refactor 2 tahun lalu
Makefile 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) 1 tahun lalu
README.md cb258f6e91 Update/fix migration URL in README. Remove errant backtick (#785) 1 tahun lalu
composer.dingo.json 266326f05e Support php-parser v5 1 tahun lalu
composer.json 138a47bed7 feat: Add Laravel 11 Support (#812) 1 tahun lalu
composer.lowest.json 266326f05e Support php-parser v5 1 tahun lalu
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 tahun lalu
logo-scribe.png 908fd36b04 Update doc 5 tahun lalu
phpstan.neon 39f57d875b Fix lint 1 tahun lalu
phpunit.xml 57b55ec1ce Support matching routes on method + path 1 tahun lalu

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.