Ana Sayfa Keşfet Yardım
Üye Ol Giriş Yap
wangjunyun
/
scribe
şunun yansıması https://github.com/knuckleswtf/scribe.git
1
0
Çatalla 0
Dosyalar Sorunlar 0 Wiki

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

Ağaç: 40a623780c
Dallar Biçim İmleri
scribe
ZIP TAR.GZ
Shalvah 40a623780c Upgrade 2 ay önce
.github bf877ad674 Update GHA trigger 2 ay önce
camel 37276c5ebc Update tests 3 ay önce
config be1ca1f9a7 Clean up config file 2 ay önce
lang 7ad83bc02c Adjust indentation 1 yıl önce
resources e230a7f40e Default tryItOut base URL to display URL 3 ay önce
routes 1a01b045e5 More Lumen cuts 2 ay önce
src 065d9a097a Clean up 2 ay önce
tests 353af36cdc Revert to old config 2 ay önce
.editorconfig c897db868e fix(.editorconfig): added formatter for .json files 3 yıl önce
.gitattributes c3a31009ba Support spatie/dto 3 3 yıl önce
.gitignore 7fa4283abc Drop Dingo 3 ay önce
CHANGELOG.md 1ad707f229 4.40.0 3 ay önce
CONTRIBUTING.md af8384feaf Update contribution guide link (#805) 1 yıl önce
Dockerfile 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) 1 yıl önce
LICENSE.md 561dac8003 Refactor 2 yıl önce
Makefile 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) 1 yıl önce
README.md 9e20117eae Drop Lumen 3 ay önce
composer.json 7bb0f39215 Upgrade minimum supported Laravel 2 ay önce
composer.lowest.json 7bb0f39215 Upgrade minimum supported Laravel 2 ay önce
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 yıl önce
logo-scribe.png 908fd36b04 Update doc 5 yıl önce
phpstan.neon 40a623780c Upgrade 2 ay önce
phpunit.xml 540f36ad59 Remove RouteRules strategy 3 ay önce

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 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.