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: 680d6ba73d
Branches Tags
scribe
ZIP TAR.GZ
Shalvah 680d6ba73d Remove conditional around invokable rule vor 2 Monaten
.github bf877ad674 Update GHA trigger vor 2 Monaten
camel d65bb0d54d Update Flysystem usage vor 2 Monaten
config c916109e48 Update strategy stubs vor 2 Monaten
lang 7ad83bc02c Adjust indentation vor 1 Jahr
resources e230a7f40e Default tryItOut base URL to display URL vor 3 Monaten
routes 1a01b045e5 More Lumen cuts vor 2 Monaten
src e30ce8b333 Avoid swallowing errors on example model instantiation (#964) vor 2 Monaten
tests 680d6ba73d Remove conditional around invokable rule vor 2 Monaten
.editorconfig c897db868e fix(.editorconfig): added formatter for .json files vor 3 Jahren
.gitattributes c3a31009ba Support spatie/dto 3 vor 3 Jahren
.gitignore 7fa4283abc Drop Dingo vor 3 Monaten
CHANGELOG.md d536a897f0 5.1.0 vor 2 Monaten
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 c5e567728e v5 vor 2 Monaten
composer.json 1839eb7890 Update deps vor 2 Monaten
composer.lowest.json a2ac416350 Update lowest vor 2 Monaten
composer.lowest.lock a2ac416350 Update lowest vor 2 Monaten
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 40a623780c Upgrade vor 2 Monaten
phpunit.xml 540f36ad59 Remove RouteRules strategy vor 3 Monaten

README.md

Scribe

Latest Stable Version Total Downloads


v5 is out now!

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.

Contributing

Contributing is easy! See our contribution guide.