Scribe可以帮助您自动生成文档，但是如果您真的想制作友好，可维护和可测试的API文档，则还需要了解更多信息。所以我为你做了一门课程。🤗
Shalvah
028d6064a5
Merge pull request #377 from james2doyle/missing-headings
|
%!s(int64=3) %!d(string=hai) anos | |
|---|---|---|
| .github | %!s(int64=3) %!d(string=hai) anos | |
| camel | %!s(int64=3) %!d(string=hai) anos | |
| config | %!s(int64=3) %!d(string=hai) anos | |
| resources | %!s(int64=3) %!d(string=hai) anos | |
| routes | %!s(int64=3) %!d(string=hai) anos | |
| src | %!s(int64=3) %!d(string=hai) anos | |
| tests | %!s(int64=3) %!d(string=hai) anos | |
| .editorconfig | %!s(int64=9) %!d(string=hai) anos | |
| .gitattributes | %!s(int64=3) %!d(string=hai) anos | |
| .gitignore | %!s(int64=5) %!d(string=hai) anos | |
| .travis.yml | %!s(int64=3) %!d(string=hai) anos | |
| CHANGELOG.md | %!s(int64=3) %!d(string=hai) anos | |
| CONTRIBUTING.md | %!s(int64=5) %!d(string=hai) anos | |
| LICENSE.md | %!s(int64=3) %!d(string=hai) anos | |
| README.md | %!s(int64=3) %!d(string=hai) anos | |
| composer.dingo.json | %!s(int64=3) %!d(string=hai) anos | |
| composer.json | %!s(int64=3) %!d(string=hai) anos | |
| composer.lowest.json | %!s(int64=3) %!d(string=hai) anos | |
| logo-scribe.png | %!s(int64=5) %!d(string=hai) anos | |
| phpstan.neon | %!s(int64=3) %!d(string=hai) anos | |
| phpunit.xml | %!s(int64=4) %!d(string=hai) anos |
README.md
Scribe
Scribe helps you generate API documentation for humans from your Laravel/Lumen/Dingo codebase. See a live example at demo.scribe.knuckles.wtf. There's a Node.js version, too!
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.
v2 docs (PHP 7.2+, not actively maintained) are at scribe.rtfd.io.
If you're coming from mpociot/laravel-apidoc-generator, there's a migration guide.
Contributing
Contributing is easy! See our contribution guide.