Головна сторінка Огляд Довідка
Реєстрація Увійти
wangjunyun
/
scribe
дзеркало https://github.com/knuckleswtf/scribe.git
1
0
Відгалуження 0
Файли Проблеми 0 Wiki

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

Дерево: 1ad707f229
Гілки Теги
scribe
ZIP TAR.GZ
Shalvah 1ad707f229 4.40.0 3 місяців тому
.github e41b0d75ea Adjust CI 1 рік тому
camel a6aee1d561 feat: add required to responseField tag and append the required fields to generateResponseContentSpec for object types (#814) 6 місяців тому
config f00f6bffa7 Update scribe.php (#928) 4 місяців тому
lang 7ad83bc02c Adjust indentation 1 рік тому
resources a26d9c912a render laravel dd() dump output properly (#893) 7 місяців тому
routes 92c128171c Final cleanups 2 роки тому
src 1ad707f229 4.40.0 3 місяців тому
tests 99b71ebf05 Fix missing required list in OpenAPI for nested body params 3 місяців тому
.editorconfig c897db868e fix(.editorconfig): added formatter for .json files 3 роки тому
.gitattributes c3a31009ba Support spatie/dto 3 3 роки тому
.gitignore ac9404ac12 Add tests for laravel type 2 роки тому
CHANGELOG.md 1ad707f229 4.40.0 3 місяців тому
CONTRIBUTING.md af8384feaf Update contribution guide link (#805) 1 рік тому
Dockerfile 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) 1 рік тому
LICENSE.md 561dac8003 Refactor 2 роки тому
Makefile 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) 1 рік тому
README.md cb258f6e91 Update/fix migration URL in README. Remove errant backtick (#785) 1 рік тому
composer.dingo.json 266326f05e Support php-parser v5 1 рік тому
composer.json 138a47bed7 feat: Add Laravel 11 Support (#812) 1 рік тому
composer.lowest.json 266326f05e Support php-parser v5 1 рік тому
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 рік тому
logo-scribe.png 908fd36b04 Update doc 5 роки тому
phpstan.neon 39f57d875b Fix lint 1 рік тому
phpunit.xml 57b55ec1ce Support matching routes on method + path 1 рік тому

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.