Scribe可以帮助您自动生成文档，但是如果您真的想制作友好，可维护和可测试的API文档，则还需要了解更多信息。所以我为你做了一门课程。🤗
Shalvah
40a623780c
Upgrade
|
2 月之前 | |
|---|---|---|
| .github | 2 月之前 | |
| camel | 3 月之前 | |
| config | 2 月之前 | |
| lang | 1 年之前 | |
| resources | 3 月之前 | |
| routes | 2 月之前 | |
| src | 2 月之前 | |
| tests | 2 月之前 | |
| .editorconfig | 3 年之前 | |
| .gitattributes | 3 年之前 | |
| .gitignore | 3 月之前 | |
| CHANGELOG.md | 3 月之前 | |
| CONTRIBUTING.md | 1 年之前 | |
| Dockerfile | 1 年之前 | |
| LICENSE.md | 2 年之前 | |
| Makefile | 1 年之前 | |
| README.md | 3 月之前 | |
| composer.json | 2 月之前 | |
| composer.lowest.json | 2 月之前 | |
| docker-compose.yml | 1 年之前 | |
| logo-scribe.png | 5 年之前 | |
| phpstan.neon | 2 月之前 | |
| phpunit.xml | 3 月之前 |
README.md
Scribe
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.