Accueil Explorer Aide
S'inscrire Connexion
wangjunyun
/
scribe
miroir de https://github.com/knuckleswtf/scribe.git
1
0
Fork 0
Fichiers Tickets 0 Wiki

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

Aborescence: fdb8f4e5ca
Branches Tags
scribe
ZIP TAR.GZ
shalvah fdb8f4e5ca Don't escape slashes in response content il y a 2 ans
.github 94d6ae2f00 Support multi-docs in `config:diff` il y a 2 ans
camel fdb8f4e5ca Don't escape slashes in response content il y a 2 ans
config 44996fe6f0 Support custom "Last updated at" label il y a 2 ans
resources 33c7a2e24b Remove unnecessary bracket in theme-default.style.css il y a 2 ans
routes 92c128171c Final cleanups il y a 2 ans
src 94d6ae2f00 Support multi-docs in `config:diff` il y a 2 ans
tests afc700b359 Add `scribe:config:diff` command il y a 2 ans
.editorconfig c897db868e fix(.editorconfig): added formatter for .json files il y a 3 ans
.gitattributes c3a31009ba Support spatie/dto 3 il y a 3 ans
.gitignore ac9404ac12 Add tests for laravel type il y a 2 ans
.travis.yml c91eed5499 Update CI il y a 3 ans
CHANGELOG.md c51adf3f82 4.6.1 il y a 2 ans
CONTRIBUTING.md 6457ea46f4 Add contribution guide il y a 5 ans
LICENSE.md 561dac8003 Refactor il y a 2 ans
README.md 6c17082f2b - il y a 2 ans
composer.dingo.json 23a6583667 Refactor il y a 2 ans
composer.json e3092307da Fix bug in upgrader il y a 2 ans
composer.lowest.json 3ea1bc647f Dingo and lowest deps il y a 2 ans
logo-scribe.png 908fd36b04 Update doc il y a 5 ans
phpstan.neon 44996fe6f0 Support custom "Last updated at" label il y a 2 ans
phpunit.xml afc700b359 Add `scribe:config:diff` command il y a 2 ans

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

  • Pretty single-page HTML doc, with human-friendly text, code samples, and included in-browser API tester ("Try It Out")
  • Extracts body parameters details from FormRequests or validation rules
  • Safely calls API endpoints to get sample responses
  • Supports generating responses from Transformers or Eloquent API Resources
  • Generates Postman collection and OpenAPI spec
  • Easily customisable with custom views and included UI components
  • Easily extensible with custom strategies
  • Statically define extra endpoints that aren'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.